Skip to content

Waldur API Documentation

Description API reference and SDK documentation for Waldur cloud management platform. See the latest version at https://docs.waldur.com
Copyright Copyright © 2016 - 2025 Waldur team

API Reference

This section provides a detailed reference for all available API endpoints.

Core

Marketplace

Billing & Finance

Proposals & Calls

Cloud & HPC Providers

Support & Operations

Billing and finance

Invoices and payments

Customer Credits

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/customer-credits/ List Customer Credits
GET /api/customer-credits/{uuid}/ Retrieve
POST /api/customer-credits/ Create
PUT /api/customer-credits/{uuid}/ Update
PATCH /api/customer-credits/{uuid}/ Partial Update
DELETE /api/customer-credits/{uuid}/ Delete
Other Actions
GET /api/customer-credits/{uuid}/consumptions/ Get credit consumption history grouped by month
POST /api/customer-credits/{uuid}/apply_compensations/ Apply compensations
POST /api/customer-credits/{uuid}/clear_compensations/ Clear compensations

Core CRUD

List Customer Credits

1
2
3
4
http \
  GET \
  https://api.example.com/api/customer-credits/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.customer_credit_o_enum import CustomerCreditOEnum # (1)
from waldur_api_client.api.customer_credits import customer_credits_list # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = customer_credits_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: CustomerCreditOEnum
  2. API Source: customer_credits_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { customerCreditsList } from 'waldur-js-client';

try {
  const response = await customerCreditsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
customer_name string
customer_slug string
customer_uuid string (uuid)
o array Ordering
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
query string

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
uuid string (uuid)
url string (uri)
value string (decimal)
customer string (uri)
customer_name string
customer_uuid string (uuid)
customer_slug string
offerings array of objects
offerings.uuid string (uuid)
offerings.url string (uri)
offerings.type string
offerings.name string
end_date string (date)
expected_consumption string (decimal)
minimal_consumption number (double)
minimal_consumption_logic string
grace_coefficient string (decimal)
apply_as_minimal_consumption boolean
allocated_to_projects number (double)
consumption_last_month number (double)

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/customer-credits/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.customer_credits import customer_credits_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = customer_credits_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: customer_credits_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { customerCreditsRetrieve } from 'waldur-js-client';

try {
  const response = await customerCreditsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
uuid string (uuid)
url string (uri)
value string (decimal)
customer string (uri)
customer_name string
customer_uuid string (uuid)
customer_slug string
offerings array of objects
offerings.uuid string (uuid)
offerings.url string (uri)
offerings.type string
offerings.name string
end_date string (date)
expected_consumption string (decimal)
minimal_consumption number (double)
minimal_consumption_logic string
grace_coefficient string (decimal)
apply_as_minimal_consumption boolean
allocated_to_projects number (double)
consumption_last_month number (double)

Create

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/customer-credits/ \
  Authorization:"Token YOUR_API_TOKEN" \
  customer="https://api.example.com/api/customer/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.create_customer_credit_request import CreateCustomerCreditRequest # (1)
from waldur_api_client.api.customer_credits import customer_credits_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = CreateCustomerCreditRequest(
    customer="https://api.example.com/api/customer/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = customer_credits_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: CreateCustomerCreditRequest
  2. API Source: customer_credits_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { customerCreditsCreate } from 'waldur-js-client';

try {
  const response = await customerCreditsCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "customer": "https://api.example.com/api/customer/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required
value string (decimal)
customer string (uri) ✓
offerings array of string (uri)s
end_date string (date)
expected_consumption string (decimal)
minimal_consumption_logic string
grace_coefficient string (decimal)
apply_as_minimal_consumption boolean

201 -

Field Type
uuid string (uuid)
url string (uri)
value string (decimal)
customer string (uri)
customer_name string
customer_uuid string (uuid)
customer_slug string
offerings array of string (uri)s
end_date string (date)
expected_consumption string (decimal)
minimal_consumption number (double)
minimal_consumption_logic string
grace_coefficient string (decimal)
apply_as_minimal_consumption boolean
allocated_to_projects number (double)
consumption_last_month number (double)

Update

1
2
3
4
5
http \
  PUT \
  https://api.example.com/api/customer-credits/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  customer="https://api.example.com/api/customer/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.create_customer_credit_request import CreateCustomerCreditRequest # (1)
from waldur_api_client.api.customer_credits import customer_credits_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = CreateCustomerCreditRequest(
    customer="https://api.example.com/api/customer/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = customer_credits_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: CreateCustomerCreditRequest
  2. API Source: customer_credits_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { customerCreditsUpdate } from 'waldur-js-client';

try {
  const response = await customerCreditsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "customer": "https://api.example.com/api/customer/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
value string (decimal)
customer string (uri) ✓
offerings array of string (uri)s
end_date string (date)
expected_consumption string (decimal)
minimal_consumption_logic string
grace_coefficient string (decimal)
apply_as_minimal_consumption boolean

200 -

Field Type
uuid string (uuid)
url string (uri)
value string (decimal)
customer string (uri)
customer_name string
customer_uuid string (uuid)
customer_slug string
offerings array of string (uri)s
end_date string (date)
expected_consumption string (decimal)
minimal_consumption number (double)
minimal_consumption_logic string
grace_coefficient string (decimal)
apply_as_minimal_consumption boolean
allocated_to_projects number (double)
consumption_last_month number (double)

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/customer-credits/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_create_customer_credit_request import PatchedCreateCustomerCreditRequest # (1)
from waldur_api_client.api.customer_credits import customer_credits_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedCreateCustomerCreditRequest()
response = customer_credits_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedCreateCustomerCreditRequest
  2. API Source: customer_credits_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { customerCreditsPartialUpdate } from 'waldur-js-client';

try {
  const response = await customerCreditsPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
value string (decimal)
customer string (uri)
offerings array of string (uri)s
end_date string (date)
expected_consumption string (decimal)
minimal_consumption_logic string
grace_coefficient string (decimal)
apply_as_minimal_consumption boolean

200 -

Field Type
uuid string (uuid)
url string (uri)
value string (decimal)
customer string (uri)
customer_name string
customer_uuid string (uuid)
customer_slug string
offerings array of string (uri)s
end_date string (date)
expected_consumption string (decimal)
minimal_consumption number (double)
minimal_consumption_logic string
grace_coefficient string (decimal)
apply_as_minimal_consumption boolean
allocated_to_projects number (double)
consumption_last_month number (double)

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/customer-credits/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.customer_credits import customer_credits_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = customer_credits_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: customer_credits_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { customerCreditsDestroy } from 'waldur-js-client';

try {
  const response = await customerCreditsDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Other Actions

Get credit consumption history grouped by month

Get credit consumption history grouped by month.

1
2
3
4
http \
  GET \
  https://api.example.com/api/customer-credits/a1b2c3d4-e5f6-7890-abcd-ef1234567890/consumptions/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.customer_credit_o_enum import CustomerCreditOEnum # (1)
from waldur_api_client.api.customer_credits import customer_credits_consumptions_list # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = customer_credits_consumptions_list.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

for item in response:
    print(item)
  1. Model Source: CustomerCreditOEnum
  2. API Source: customer_credits_consumptions_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { customerCreditsConsumptionsList } from 'waldur-js-client';

try {
  const response = await customerCreditsConsumptionsList({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type Description
customer_name string
customer_slug string
customer_uuid string (uuid)
o array Ordering
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
query string

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
date string (date)
price string (decimal)

Apply compensations

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/customer-credits/a1b2c3d4-e5f6-7890-abcd-ef1234567890/apply_compensations/ \
  Authorization:"Token YOUR_API_TOKEN" \
  customer="https://api.example.com/api/customer/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.customer_credit_request import CustomerCreditRequest # (1)
from waldur_api_client.api.customer_credits import customer_credits_apply_compensations # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = CustomerCreditRequest(
    customer="https://api.example.com/api/customer/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = customer_credits_apply_compensations.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: CustomerCreditRequest
  2. API Source: customer_credits_apply_compensations
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { customerCreditsApplyCompensations } from 'waldur-js-client';

try {
  const response = await customerCreditsApplyCompensations({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "customer": "https://api.example.com/api/customer/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
value string (decimal)
customer string (uri) ✓
end_date string (date)
expected_consumption string (decimal)
minimal_consumption_logic string
grace_coefficient string (decimal)
apply_as_minimal_consumption boolean

200 -

Field Type
uuid string (uuid)
url string (uri)
value string (decimal)
customer string (uri)
customer_name string
customer_uuid string (uuid)
customer_slug string
offerings array of objects
offerings.uuid string (uuid)
offerings.url string (uri)
offerings.type string
offerings.name string
end_date string (date)
expected_consumption string (decimal)
minimal_consumption number (double)
minimal_consumption_logic string
grace_coefficient string (decimal)
apply_as_minimal_consumption boolean
allocated_to_projects number (double)
consumption_last_month number (double)

Clear compensations

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/customer-credits/a1b2c3d4-e5f6-7890-abcd-ef1234567890/clear_compensations/ \
  Authorization:"Token YOUR_API_TOKEN" \
  customer="https://api.example.com/api/customer/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.customer_credit_request import CustomerCreditRequest # (1)
from waldur_api_client.api.customer_credits import customer_credits_clear_compensations # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = CustomerCreditRequest(
    customer="https://api.example.com/api/customer/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = customer_credits_clear_compensations.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: CustomerCreditRequest
  2. API Source: customer_credits_clear_compensations
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { customerCreditsClearCompensations } from 'waldur-js-client';

try {
  const response = await customerCreditsClearCompensations({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "customer": "https://api.example.com/api/customer/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
value string (decimal)
customer string (uri) ✓
end_date string (date)
expected_consumption string (decimal)
minimal_consumption_logic string
grace_coefficient string (decimal)
apply_as_minimal_consumption boolean

200 -

Field Type
uuid string (uuid)
url string (uri)
value string (decimal)
customer string (uri)
customer_name string
customer_uuid string (uuid)
customer_slug string
offerings array of objects
offerings.uuid string (uuid)
offerings.url string (uri)
offerings.type string
offerings.name string
end_date string (date)
expected_consumption string (decimal)
minimal_consumption number (double)
minimal_consumption_logic string
grace_coefficient string (decimal)
apply_as_minimal_consumption boolean
allocated_to_projects number (double)
consumption_last_month number (double)

Invoice Items

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/invoice-items/ List Invoice Items
GET /api/invoice-items/{uuid}/ Retrieve
POST /api/invoice-items/{uuid}/create_compensation/ Create compensation invoice item for selected invoice item
PUT /api/invoice-items/{uuid}/ Update
PATCH /api/invoice-items/{uuid}/ Partial Update
DELETE /api/invoice-items/{uuid}/ Delete
Other Actions
GET /api/invoice-items/{uuid}/consumptions/ Consumptions
GET /api/invoice-items/costs/ Get costs breakdown for a project by year and month
GET /api/invoice-items/customer_costs_for_period/ Customer costs for period
GET /api/invoice-items/project_costs_for_period/ Get resource cost breakdown for a project over a specified period
GET /api/invoice-items/total_price/ Calculate total price for filtered invoice items
POST /api/invoice-items/{uuid}/migrate_to/ Move invoice item from one invoice to another one

Core CRUD

List Invoice Items

1
2
3
4
http \
  GET \
  https://api.example.com/api/invoice-items/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.invoice_items import invoice_items_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = invoice_items_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: invoice_items_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { invoiceItemsList } from 'waldur-js-client';

try {
  const response = await invoiceItemsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
credit_uuid string (uuid)
customer_uuid string (uuid)
month integer
offering_uuid string (uuid)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
project_uuid string (uuid)
resource_uuid string (uuid)
start_month number Start month
start_year number Start year
year integer

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
invoice string (uri)
resource string (uri)
uuid string (uuid)
article_code string
unit_price string (decimal)
unit string
Enum: month, quarter, half_month, day, hour, quantity
quantity string (decimal)
measured_unit string Unit of measurement, for example, GB.
name string
start string (date-time) Date and time when item usage has started.
end string (date-time) Date and time when item usage has ended.
price number (double)
details any Stores data about scope
offering_uuid string (uuid)
offering_name string
offering_component_type string
project_uuid string (uuid)
project_name string
customer_uuid string (uuid)
customer_name string

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/invoice-items/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.invoice_items import invoice_items_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = invoice_items_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: invoice_items_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { invoiceItemsRetrieve } from 'waldur-js-client';

try {
  const response = await invoiceItemsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
invoice string (uri)
resource string (uri)
uuid string (uuid)
article_code string
unit_price string (decimal)
unit string
Enum: month, quarter, half_month, day, hour, quantity
quantity string (decimal)
measured_unit string Unit of measurement, for example, GB.
name string
start string (date-time) Date and time when item usage has started.
end string (date-time) Date and time when item usage has ended.
price number (double)
details any Stores data about scope
offering_uuid string (uuid)
offering_name string
offering_component_type string
project_uuid string (uuid)
project_name string
customer_uuid string (uuid)
customer_name string

Create compensation invoice item for selected invoice item

Create compensation invoice item for selected invoice item.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/invoice-items/a1b2c3d4-e5f6-7890-abcd-ef1234567890/create_compensation/ \
  Authorization:"Token YOUR_API_TOKEN" \
  offering_component_name="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.invoice_item_compensation_request import InvoiceItemCompensationRequest # (1)
from waldur_api_client.api.invoice_items import invoice_items_create_compensation # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = InvoiceItemCompensationRequest(
    offering_component_name="string-value"
)
response = invoice_items_create_compensation.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: InvoiceItemCompensationRequest
  2. API Source: invoice_items_create_compensation
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { invoiceItemsCreateCompensation } from 'waldur-js-client';

try {
  const response = await invoiceItemsCreateCompensation({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "offering_component_name": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
offering_component_name string ✓ Name of the offering component for compensation

200 -

Field Type Description
offering_component_name string Name of the offering component for compensation

Update

1
2
3
4
http \
  PUT \
  https://api.example.com/api/invoice-items/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.invoice_item_update_request import InvoiceItemUpdateRequest # (1)
from waldur_api_client.api.invoice_items import invoice_items_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = InvoiceItemUpdateRequest()
response = invoice_items_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: InvoiceItemUpdateRequest
  2. API Source: invoice_items_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { invoiceItemsUpdate } from 'waldur-js-client';

try {
  const response = await invoiceItemsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
article_code string
quantity string (decimal)
unit_price string (decimal)
start string (date-time) Date and time when item usage has started.
end string (date-time) Date and time when item usage has ended.

200 -

Field Type Description
article_code string
quantity string (decimal)
unit_price string (decimal)
start string (date-time) Date and time when item usage has started.
end string (date-time) Date and time when item usage has ended.

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/invoice-items/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_invoice_item_update_request import PatchedInvoiceItemUpdateRequest # (1)
from waldur_api_client.api.invoice_items import invoice_items_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedInvoiceItemUpdateRequest()
response = invoice_items_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedInvoiceItemUpdateRequest
  2. API Source: invoice_items_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { invoiceItemsPartialUpdate } from 'waldur-js-client';

try {
  const response = await invoiceItemsPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
article_code string
quantity string (decimal)
unit_price string (decimal)
start string (date-time) Date and time when item usage has started.
end string (date-time) Date and time when item usage has ended.

200 -

Field Type Description
article_code string
quantity string (decimal)
unit_price string (decimal)
start string (date-time) Date and time when item usage has started.
end string (date-time) Date and time when item usage has ended.

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/invoice-items/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.invoice_items import invoice_items_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = invoice_items_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: invoice_items_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { invoiceItemsDestroy } from 'waldur-js-client';

try {
  const response = await invoiceItemsDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Other Actions

Consumptions

1
2
3
4
http \
  GET \
  https://api.example.com/api/invoice-items/a1b2c3d4-e5f6-7890-abcd-ef1234567890/consumptions/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.invoice_items import invoice_items_consumptions_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = invoice_items_consumptions_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: invoice_items_consumptions_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { invoiceItemsConsumptionsRetrieve } from 'waldur-js-client';

try {
  const response = await invoiceItemsConsumptionsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
invoice string (uri)
resource string (uri)
uuid string (uuid)
article_code string
unit_price string (decimal)
unit string
Enum: month, quarter, half_month, day, hour, quantity
quantity string (decimal)
measured_unit string Unit of measurement, for example, GB.
name string
start string (date-time) Date and time when item usage has started.
end string (date-time) Date and time when item usage has ended.
price number (double)
details any Stores data about scope
offering_uuid string (uuid)
offering_name string
offering_component_type string
project_uuid string (uuid)
project_name string
customer_uuid string (uuid)
customer_name string

Get costs breakdown for a project by year and month

Get costs breakdown for a project by year and month.

1
2
3
4
http \
  GET \
  https://api.example.com/api/invoice-items/costs/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.invoice_items import invoice_items_costs_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = invoice_items_costs_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: invoice_items_costs_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { invoiceItemsCostsList } from 'waldur-js-client';

try {
  const response = await invoiceItemsCostsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
project_uuid string (uuid) UUID of the project for which statistics should be calculated.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
price number (double)
year integer
month integer
items array of objects
items.name string
items.unit_price string (decimal)
items.unit string
items.quantity string (decimal)
items.measured_unit string
items.price number (double)

Customer costs for period

1
2
3
4
http \
  GET \
  https://api.example.com/api/invoice-items/customer_costs_for_period/ \
  Authorization:"Token YOUR_API_TOKEN"

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.invoice_items import invoice_items_customer_costs_for_period_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = invoice_items_customer_costs_for_period_retrieve.sync(client=client)

print(response)
  1. API Source: invoice_items_customer_costs_for_period_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { invoiceItemsCustomerCostsForPeriodRetrieve } from 'waldur-js-client';

try {
  const response = await invoiceItemsCustomerCostsForPeriodRetrieve({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
customer_uuid string (uuid) UUID of the project for which statistics should be calculated.
period integer Period for which statistics should be calculated.

200 -

Field Type
total_price string
start_date string (date)
end_date string (date)

Get resource cost breakdown for a project over a specified period

Get resource cost breakdown for a project over a specified period.

1
2
3
4
http \
  GET \
  https://api.example.com/api/invoice-items/project_costs_for_period/ \
  Authorization:"Token YOUR_API_TOKEN"

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.invoice_items import invoice_items_project_costs_for_period_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = invoice_items_project_costs_for_period_retrieve.sync(client=client)

print(response)
  1. API Source: invoice_items_project_costs_for_period_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { invoiceItemsProjectCostsForPeriodRetrieve } from 'waldur-js-client';

try {
  const response = await invoiceItemsProjectCostsForPeriodRetrieve({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
period integer Period for which statistics should be calculated (1, 3 or 12 months).
project_uuid string (uuid) UUID of the project for which statistics should be calculated.

200 -

Field Type
total_price string
start_date string (date)
end_date string (date)

Calculate total price for filtered invoice items

Calculate total price for filtered invoice items.

1
2
3
4
http \
  GET \
  https://api.example.com/api/invoice-items/total_price/ \
  Authorization:"Token YOUR_API_TOKEN"

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.invoice_items import invoice_items_total_price_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = invoice_items_total_price_retrieve.sync(client=client)

print(response)
  1. API Source: invoice_items_total_price_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { invoiceItemsTotalPriceRetrieve } from 'waldur-js-client';

try {
  const response = await invoiceItemsTotalPriceRetrieve({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
credit_uuid string (uuid)
customer_uuid string (uuid)
month integer
offering_uuid string (uuid)
project_uuid string (uuid)
resource_uuid string (uuid)
start_month number Start month
start_year number Start year
year integer

200 -

Field Type Description
total_price string (decimal) Total price for the invoice item

Move invoice item from one invoice to another one

Move invoice item from one invoice to another one.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/invoice-items/a1b2c3d4-e5f6-7890-abcd-ef1234567890/migrate_to/ \
  Authorization:"Token YOUR_API_TOKEN" \
  invoice="https://api.example.com/api/invoice/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.invoice_item_migrate_to_request import InvoiceItemMigrateToRequest # (1)
from waldur_api_client.api.invoice_items import invoice_items_migrate_to # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = InvoiceItemMigrateToRequest(
    invoice="https://api.example.com/api/invoice/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = invoice_items_migrate_to.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: InvoiceItemMigrateToRequest
  2. API Source: invoice_items_migrate_to
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { invoiceItemsMigrateTo } from 'waldur-js-client';

try {
  const response = await invoiceItemsMigrateTo({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "invoice": "https://api.example.com/api/invoice/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
invoice string (uri) ✓

200 -

Field Type
invoice string (uri)

Invoice

Operations Summary

Method Endpoint Description
POST /api/invoice/send-financial-report-by-mail/ Send financial report by mail

Send financial report by mail

1
2
3
4
5
6
7
http \
  POST \
  https://api.example.com/api/invoice/send-financial-report-by-mail/ \
  Authorization:"Token YOUR_API_TOKEN" \
  emails:='[]' \
  year=123 \
  month=123

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.financial_report_email_request import FinancialReportEmailRequest # (1)
from waldur_api_client.api.invoice import invoice_send_financial_report_by_mail # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = FinancialReportEmailRequest(
    emails=[],
    year=123,
    month=123
)
response = invoice_send_financial_report_by_mail.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: FinancialReportEmailRequest
  2. API Source: invoice_send_financial_report_by_mail
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
import { invoiceSendFinancialReportByMail } from 'waldur-js-client';

try {
  const response = await invoiceSendFinancialReportByMail({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "emails": [],
    "year": 123,
    "month": 123
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required
emails array of string (email)s ✓
year integer ✓
month integer ✓

200 - No response body

Invoices

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/invoices/ List Invoices
GET /api/invoices/{uuid}/ Retrieve
Other Actions
GET /api/invoices/growth/ List Invoices Growth
GET /api/invoices/{uuid}/history/at/ Get object state at a specific timestamp
GET /api/invoices/{uuid}/history/ Get version history
GET /api/invoices/{uuid}/items/ Get invoice items
GET /api/invoices/{uuid}/stats/ Spendings grouped by offerings and filtered by provider
POST /api/invoices/import_usage/ Import usage data
POST /api/invoices/{uuid}/paid/ Mark invoice as paid and optionally create payment record with proof of payment
POST /api/invoices/{uuid}/send_notification/ Send invoice notification
POST /api/invoices/{uuid}/set_backend_id/ Set backend ID for invoice
POST /api/invoices/{uuid}/set_payment_url/ Set payment URL for invoice
POST /api/invoices/{uuid}/set_reference_number/ Set reference number for invoice

Core CRUD

List Invoices

1
2
3
4
http \
  GET \
  https://api.example.com/api/invoices/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.invoice_field_enum import InvoiceFieldEnum # (1)
from waldur_api_client.models.invoice_o_enum import InvoiceOEnum # (2)
from waldur_api_client.models.invoice_state_enum import InvoiceStateEnum # (3)
from waldur_api_client.api.invoices import invoices_list # (4)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = invoices_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: InvoiceFieldEnum
  2. Model Source: InvoiceOEnum
  3. Model Source: InvoiceStateEnum
  4. API Source: invoices_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { invoicesList } from 'waldur-js-client';

try {
  const response = await invoicesList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
accounting_is_running boolean Filter by whether accounting is running.
created string (date)
customer string (uri)
customer_uuid string (uuid)
end_date string (date)
field array
month integer
o array Ordering
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
start_date string (date)
state array
year integer

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
number integer
customer string (uri)
price string (decimal)
tax string (decimal)
total string (decimal)
state string
Enum: pending, pending_finalization, created, paid, canceled
year integer
month integer
issuer_details any
invoice_date string (date) Date then invoice moved from state pending to created.
due_date string (date)
customer_details object
customer_details.name string
customer_details.address string
customer_details.country string
customer_details.country_name string
customer_details.email string (email)
customer_details.postal string
customer_details.phone_number string
customer_details.bank_name string
customer_details.bank_account string
customer_details.vat_code string VAT number
items array of objects
items.uuid string (uuid)
items.url string (uri)
items.name string
items.price number (double)
items.tax string (decimal)
items.total string (decimal)
items.unit_price string (decimal)
items.unit string
Enum: month, quarter, half_month, day, hour, quantity
items.factor integer
items.measured_unit string
items.start string (date-time) Date and time when item usage has started.
items.end string (date-time) Date and time when item usage has ended.
items.article_code string
items.project_name string
items.project_uuid string (uuid)
items.quantity string (decimal)
items.details object
items.details.resource_name string Name of the marketplace resource
items.details.resource_uuid string (uuid) UUID of the marketplace resource
items.details.plan_name string Name of the pricing plan
items.details.plan_uuid string (uuid) UUID of the pricing plan
items.details.offering_type string Type of the offering
items.details.offering_name string Name of the offering
items.details.offering_uuid string (uuid) UUID of the offering
items.details.service_provider_name string Name of the service provider
items.details.service_provider_uuid string (uuid) UUID of the service provider
items.details.plan_component_id integer ID of the plan component
items.details.offering_component_type string Type of the offering component
items.details.offering_component_name string Name of the offering component
items.details.resource_limit_periods array of objects List of resource limit periods for this invoice item
items.details.resource_limit_periods.start string Start date of the resource limit period
items.details.resource_limit_periods.end string End date of the resource limit period
items.details.resource_limit_periods.quantity integer Quantity of resources consumed during this period
items.details.resource_limit_periods.billing_periods integer Number of billing periods
items.details.resource_limit_periods.total string Total amount for this period
items.resource string (uri)
items.resource_uuid string (uuid)
items.resource_name string
items.billing_type string
items.backend_uuid string (uuid)
items.credit boolean
backend_id string
payment_url string (uri) URL for initiating payment via payment gateway.
reference_number string Reference number associated with the invoice.
compensations number (double)
incurred_costs number (double)

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/invoices/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.invoice_field_enum import InvoiceFieldEnum # (1)
from waldur_api_client.api.invoices import invoices_retrieve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = invoices_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. Model Source: InvoiceFieldEnum
  2. API Source: invoices_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { invoicesRetrieve } from 'waldur-js-client';

try {
  const response = await invoicesRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type
field array

200 -

Field Type Description
url string (uri)
uuid string (uuid)
number integer
customer string (uri)
price string (decimal)
tax string (decimal)
total string (decimal)
state string
Enum: pending, pending_finalization, created, paid, canceled
year integer
month integer
issuer_details any
invoice_date string (date) Date then invoice moved from state pending to created.
due_date string (date)
customer_details object
customer_details.name string
customer_details.address string
customer_details.country string
customer_details.country_name string
customer_details.email string (email)
customer_details.postal string
customer_details.phone_number string
customer_details.bank_name string
customer_details.bank_account string
customer_details.vat_code string VAT number
items array of objects
items.uuid string (uuid)
items.url string (uri)
items.name string
items.price number (double)
items.tax string (decimal)
items.total string (decimal)
items.unit_price string (decimal)
items.unit string
Enum: month, quarter, half_month, day, hour, quantity
items.factor integer
items.measured_unit string
items.start string (date-time) Date and time when item usage has started.
items.end string (date-time) Date and time when item usage has ended.
items.article_code string
items.project_name string
items.project_uuid string (uuid)
items.quantity string (decimal)
items.details object
items.details.resource_name string Name of the marketplace resource
items.details.resource_uuid string (uuid) UUID of the marketplace resource
items.details.plan_name string Name of the pricing plan
items.details.plan_uuid string (uuid) UUID of the pricing plan
items.details.offering_type string Type of the offering
items.details.offering_name string Name of the offering
items.details.offering_uuid string (uuid) UUID of the offering
items.details.service_provider_name string Name of the service provider
items.details.service_provider_uuid string (uuid) UUID of the service provider
items.details.plan_component_id integer ID of the plan component
items.details.offering_component_type string Type of the offering component
items.details.offering_component_name string Name of the offering component
items.details.resource_limit_periods array of objects List of resource limit periods for this invoice item
items.details.resource_limit_periods.start string Start date of the resource limit period
items.details.resource_limit_periods.end string End date of the resource limit period
items.details.resource_limit_periods.quantity integer Quantity of resources consumed during this period
items.details.resource_limit_periods.billing_periods integer Number of billing periods
items.details.resource_limit_periods.total string Total amount for this period
items.resource string (uri)
items.resource_uuid string (uuid)
items.resource_name string
items.billing_type string
items.backend_uuid string (uuid)
items.credit boolean
backend_id string
payment_url string (uri) URL for initiating payment via payment gateway.
reference_number string Reference number associated with the invoice.
compensations number (double)
incurred_costs number (double)

Other Actions

List Invoices Growth

Analyze invoice trends over time by comparing monthly totals for major customers versus others over the past year.

1
2
3
4
http \
  GET \
  https://api.example.com/api/invoices/growth/ \
  Authorization:"Token YOUR_API_TOKEN"

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.invoices import invoices_growth_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = invoices_growth_retrieve.sync(client=client)

print(response)
  1. API Source: invoices_growth_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { invoicesGrowthRetrieve } from 'waldur-js-client';

try {
  const response = await invoicesGrowthRetrieve({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type
accounting_is_running boolean
accounting_mode string
customers_count integer

200 -

Field Type
periods array of strings
total_periods array of number (double)s
other_periods array of number (double)s
customer_periods array of objects
customer_periods.name string
customer_periods.periods array of number (double)s

Get object state at a specific timestamp

Returns the state of the object as it was at the specified timestamp. Only accessible by staff and support users.

1
2
3
4
5
http \
  GET \
  https://api.example.com/api/invoices/a1b2c3d4-e5f6-7890-abcd-ef1234567890/history/at/ \
  Authorization:"Token YOUR_API_TOKEN" \
  timestamp=="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.invoices import invoices_history_at_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = invoices_history_at_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    timestamp="string-value"
)

print(response)
  1. API Source: invoices_history_at_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { invoicesHistoryAtRetrieve } from 'waldur-js-client';

try {
  const response = await invoicesHistoryAtRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  query: {
    "timestamp": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type Required Description
timestamp string ✓ ISO 8601 timestamp to query the object state at

200 -

Field Type Description
id integer Version ID
revision_date string (date-time) When this revision was created
revision_user object (free-form) User who created this revision
revision_comment string Comment describing the revision
serialized_data object (free-form) Serialized model fields at this revision

400 -

404 -

Get version history

Returns the version history for this object. Only accessible by staff and support users.

1
2
3
4
http \
  GET \
  https://api.example.com/api/invoices/a1b2c3d4-e5f6-7890-abcd-ef1234567890/history/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.invoice_o_enum import InvoiceOEnum # (1)
from waldur_api_client.models.invoice_state_enum import InvoiceStateEnum # (2)
from waldur_api_client.api.invoices import invoices_history_list # (3)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = invoices_history_list.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

for item in response:
    print(item)
  1. Model Source: InvoiceOEnum
  2. Model Source: InvoiceStateEnum
  3. API Source: invoices_history_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { invoicesHistoryList } from 'waldur-js-client';

try {
  const response = await invoicesHistoryList({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type Description
accounting_is_running boolean Filter by whether accounting is running.
created string (date)
created_after string Filter versions created after this timestamp (ISO 8601)
created_before string Filter versions created before this timestamp (ISO 8601)
customer string (uri)
customer_uuid string (uuid)
end_date string (date)
month integer
o array Ordering
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
start_date string (date)
state array
year integer

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
id integer Version ID
revision_date string (date-time) When this revision was created
revision_user object (free-form) User who created this revision
revision_comment string Comment describing the revision
serialized_data object (free-form) Serialized model fields at this revision

Get invoice items

Retrieve a list of invoice items for the specified invoice.

1
2
3
4
http \
  GET \
  https://api.example.com/api/invoices/a1b2c3d4-e5f6-7890-abcd-ef1234567890/items/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.invoice_item_o_enum import InvoiceItemOEnum # (1)
from waldur_api_client.api.invoices import invoices_items_retrieve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = invoices_items_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. Model Source: InvoiceItemOEnum
  2. API Source: invoices_items_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { invoicesItemsRetrieve } from 'waldur-js-client';

try {
  const response = await invoicesItemsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type Description
conceal_compensation_items boolean Conceal compensation items
o string Order results by field
Enum: project_name, -project_name, resource_name, -resource_name, provider_name, -provider_name, name, -name
offering_uuid string (uuid)
project_uuid string (uuid)
provider_uuid string (uuid)
query string

200 -

Field Type Description
uuid string (uuid)
url string (uri)
name string
price number (double)
tax string (decimal)
total string (decimal)
unit_price string (decimal)
unit string
Enum: month, quarter, half_month, day, hour, quantity
factor integer
measured_unit string
start string (date-time) Date and time when item usage has started.
end string (date-time) Date and time when item usage has ended.
article_code string
project_name string
project_uuid string (uuid)
quantity string (decimal)
details object
details.resource_name string Name of the marketplace resource
details.resource_uuid string (uuid) UUID of the marketplace resource
details.plan_name string Name of the pricing plan
details.plan_uuid string (uuid) UUID of the pricing plan
details.offering_type string Type of the offering
details.offering_name string Name of the offering
details.offering_uuid string (uuid) UUID of the offering
details.service_provider_name string Name of the service provider
details.service_provider_uuid string (uuid) UUID of the service provider
details.plan_component_id integer ID of the plan component
details.offering_component_type string Type of the offering component
details.offering_component_name string Name of the offering component
details.resource_limit_periods array of objects List of resource limit periods for this invoice item
details.resource_limit_periods.start string Start date of the resource limit period
details.resource_limit_periods.end string End date of the resource limit period
details.resource_limit_periods.quantity integer Quantity of resources consumed during this period
details.resource_limit_periods.billing_periods integer Number of billing periods
details.resource_limit_periods.total string Total amount for this period
resource string (uri)
resource_uuid string (uuid)
resource_name string
billing_type string
backend_uuid string (uuid)
credit boolean

Spendings grouped by offerings and filtered by provider

Spendings grouped by offerings and filtered by provider.

1
2
3
4
http \
  GET \
  https://api.example.com/api/invoices/a1b2c3d4-e5f6-7890-abcd-ef1234567890/stats/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.invoice_o_enum import InvoiceOEnum # (1)
from waldur_api_client.models.invoice_state_enum import InvoiceStateEnum # (2)
from waldur_api_client.api.invoices import invoices_stats_list # (3)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = invoices_stats_list.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

for item in response:
    print(item)
  1. Model Source: InvoiceOEnum
  2. Model Source: InvoiceStateEnum
  3. API Source: invoices_stats_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { invoicesStatsList } from 'waldur-js-client';

try {
  const response = await invoicesStatsList({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type Description
accounting_is_running boolean Filter by whether accounting is running.
created string (date)
customer string (uri)
customer_uuid string (uuid)
end_date string (date)
month integer
o array Ordering
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
provider_uuid string (uuid)
start_date string (date)
state array
year integer

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
offering_name string
aggregated_price number (double)
aggregated_tax number (double)
aggregated_total number (double)
service_category_title string
service_provider_name string
service_provider_uuid string (uuid)

Import usage data

Import component usage items as JSON data for multiple customers. Creates invoice items for the specified billing period. Items are deduplicated by name, customer, and billing period to prevent duplicates.

1
2
3
4
5
6
7
http \
  POST \
  https://api.example.com/api/invoices/import_usage/ \
  Authorization:"Token YOUR_API_TOKEN" \
  year=123 \
  month=123 \
  items:='[]'

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.import_usage_request import ImportUsageRequest # (1)
from waldur_api_client.api.invoices import invoices_import_usage # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ImportUsageRequest(
    year=123,
    month=123,
    items=[]
)
response = invoices_import_usage.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ImportUsageRequest
  2. API Source: invoices_import_usage
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
import { invoicesImportUsage } from 'waldur-js-client';

try {
  const response = await invoicesImportUsage({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "year": 123,
    "month": 123,
    "items": []
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required
year integer ✓
month integer ✓
items array of objects ✓
items.customer_name string
items.customer_uuid string (uuid)
items.name string ✓
items.unit_price string (decimal) ✓
items.article_code string
items.service_provider_name string
items.offering_name string
items.plan_name string

200 -

Field Type
created integer
skipped integer
errors array of objects

Mark invoice as paid and optionally create payment record with proof of payment

Mark invoice as paid and optionally create payment record with proof of payment.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/invoices/a1b2c3d4-e5f6-7890-abcd-ef1234567890/paid/ \
  Authorization:"Token YOUR_API_TOKEN" \
  date="2023-10-01"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.paid_request import PaidRequest # (1)
from waldur_api_client.api.invoices import invoices_paid # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PaidRequest(
    date="2023-10-01"
)
response = invoices_paid.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PaidRequest
  2. API Source: invoices_paid
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { invoicesPaid } from 'waldur-js-client';

try {
  const response = await invoicesPaid({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "date": "2023-10-01"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
date string (date) ✓
proof string (binary)

200 -

Field Type Description
url string (uri)
uuid string (uuid)
number integer
customer string (uri)
price string (decimal)
tax string (decimal)
total string (decimal)
state string
Enum: pending, pending_finalization, created, paid, canceled
year integer
month integer
issuer_details any
invoice_date string (date) Date then invoice moved from state pending to created.
due_date string (date)
customer_details object
customer_details.name string
customer_details.address string
customer_details.country string
customer_details.country_name string
customer_details.email string (email)
customer_details.postal string
customer_details.phone_number string
customer_details.bank_name string
customer_details.bank_account string
customer_details.vat_code string VAT number
items array of objects
items.uuid string (uuid)
items.url string (uri)
items.name string
items.price number (double)
items.tax string (decimal)
items.total string (decimal)
items.unit_price string (decimal)
items.unit string
Enum: month, quarter, half_month, day, hour, quantity
items.factor integer
items.measured_unit string
items.start string (date-time) Date and time when item usage has started.
items.end string (date-time) Date and time when item usage has ended.
items.article_code string
items.project_name string
items.project_uuid string (uuid)
items.quantity string (decimal)
items.details object
items.details.resource_name string Name of the marketplace resource
items.details.resource_uuid string (uuid) UUID of the marketplace resource
items.details.plan_name string Name of the pricing plan
items.details.plan_uuid string (uuid) UUID of the pricing plan
items.details.offering_type string Type of the offering
items.details.offering_name string Name of the offering
items.details.offering_uuid string (uuid) UUID of the offering
items.details.service_provider_name string Name of the service provider
items.details.service_provider_uuid string (uuid) UUID of the service provider
items.details.plan_component_id integer ID of the plan component
items.details.offering_component_type string Type of the offering component
items.details.offering_component_name string Name of the offering component
items.details.resource_limit_periods array of objects List of resource limit periods for this invoice item
items.details.resource_limit_periods.start string Start date of the resource limit period
items.details.resource_limit_periods.end string End date of the resource limit period
items.details.resource_limit_periods.quantity integer Quantity of resources consumed during this period
items.details.resource_limit_periods.billing_periods integer Number of billing periods
items.details.resource_limit_periods.total string Total amount for this period
items.resource string (uri)
items.resource_uuid string (uuid)
items.resource_name string
items.billing_type string
items.backend_uuid string (uuid)
items.credit boolean
backend_id string
payment_url string (uri) URL for initiating payment via payment gateway.
reference_number string Reference number associated with the invoice.
compensations number (double)
incurred_costs number (double)

Send invoice notification

Schedule sending of a notification for the specified invoice.

1
2
3
4
http \
  POST \
  https://api.example.com/api/invoices/a1b2c3d4-e5f6-7890-abcd-ef1234567890/send_notification/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.invoices import invoices_send_notification # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = invoices_send_notification.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: invoices_send_notification
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { invoicesSendNotification } from 'waldur-js-client';

try {
  const response = await invoicesSendNotification({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 - No response body

Set backend ID for invoice

Set backend ID for invoice.

1
2
3
4
http \
  POST \
  https://api.example.com/api/invoices/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_backend_id/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.backend_id_request import BackendIdRequest # (1)
from waldur_api_client.api.invoices import invoices_set_backend_id # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = BackendIdRequest()
response = invoices_set_backend_id.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: BackendIdRequest
  2. API Source: invoices_set_backend_id
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { invoicesSetBackendId } from 'waldur-js-client';

try {
  const response = await invoicesSetBackendId({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
backend_id string

200 - No response body

Set payment URL for invoice

Set payment URL for invoice.

1
2
3
4
http \
  POST \
  https://api.example.com/api/invoices/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_payment_url/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.payment_url_request import PaymentURLRequest # (1)
from waldur_api_client.api.invoices import invoices_set_payment_url # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PaymentURLRequest()
response = invoices_set_payment_url.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PaymentURLRequest
  2. API Source: invoices_set_payment_url
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { invoicesSetPaymentUrl } from 'waldur-js-client';

try {
  const response = await invoicesSetPaymentUrl({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
payment_url string (uri) URL for initiating payment via payment gateway.

200 - No response body

Set reference number for invoice

Set reference number for invoice.

1
2
3
4
http \
  POST \
  https://api.example.com/api/invoices/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_reference_number/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.reference_number_request import ReferenceNumberRequest # (1)
from waldur_api_client.api.invoices import invoices_set_reference_number # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ReferenceNumberRequest()
response = invoices_set_reference_number.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ReferenceNumberRequest
  2. API Source: invoices_set_reference_number
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { invoicesSetReferenceNumber } from 'waldur-js-client';

try {
  const response = await invoicesSetReferenceNumber({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
reference_number string Reference number associated with the invoice.

200 - No response body

Payment Profiles

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/payment-profiles/ List Payment Profiles
GET /api/payment-profiles/{uuid}/ Retrieve
POST /api/payment-profiles/ Create
PUT /api/payment-profiles/{uuid}/ Update
PATCH /api/payment-profiles/{uuid}/ Partial Update
DELETE /api/payment-profiles/{uuid}/ Delete
Other Actions
POST /api/payment-profiles/{uuid}/enable/ Enable

Core CRUD

List Payment Profiles

1
2
3
4
http \
  GET \
  https://api.example.com/api/payment-profiles/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.payment_profile_o_enum import PaymentProfileOEnum # (1)
from waldur_api_client.models.payment_type_enum import PaymentTypeEnum # (2)
from waldur_api_client.api.payment_profiles import payment_profiles_list # (3)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = payment_profiles_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: PaymentProfileOEnum
  2. Model Source: PaymentTypeEnum
  3. API Source: payment_profiles_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { paymentProfilesList } from 'waldur-js-client';

try {
  const response = await paymentProfilesList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
is_active boolean
o array Ordering
organization string (uri)
organization_uuid string (uuid)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
payment_type array

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
uuid string (uuid)
url string (uri)
name string
organization_uuid string (uuid)
organization string (uri)
attributes object
attributes.end_date string
attributes.agreement_number string
attributes.contract_sum integer
payment_type string
payment_type_display string
is_active boolean

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/payment-profiles/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.payment_profiles import payment_profiles_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = payment_profiles_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: payment_profiles_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { paymentProfilesRetrieve } from 'waldur-js-client';

try {
  const response = await paymentProfilesRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
uuid string (uuid)
url string (uri)
name string
organization_uuid string (uuid)
organization string (uri)
attributes object
attributes.end_date string
attributes.agreement_number string
attributes.contract_sum integer
payment_type string
payment_type_display string
is_active boolean

Create

1
2
3
4
5
6
7
http \
  POST \
  https://api.example.com/api/payment-profiles/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-payment-profile" \
  organization="https://api.example.com/api/organization/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  payment_type="fixed_price"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.payment_profile_request import PaymentProfileRequest # (1)
from waldur_api_client.api.payment_profiles import payment_profiles_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PaymentProfileRequest(
    name="my-awesome-payment-profile",
    organization="https://api.example.com/api/organization/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    payment_type="fixed_price"
)
response = payment_profiles_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PaymentProfileRequest
  2. API Source: payment_profiles_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
import { paymentProfilesCreate } from 'waldur-js-client';

try {
  const response = await paymentProfilesCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "name": "my-awesome-payment-profile",
    "organization": "https://api.example.com/api/organization/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "payment_type": "fixed_price"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required
name string ✓
organization string (uri) ✓
attributes object
attributes.end_date string
attributes.agreement_number string
attributes.contract_sum integer
payment_type string ✓
is_active boolean

201 -

Field Type
uuid string (uuid)
url string (uri)
name string
organization_uuid string (uuid)
organization string (uri)
attributes object
attributes.end_date string
attributes.agreement_number string
attributes.contract_sum integer
payment_type string
payment_type_display string
is_active boolean

Update

1
2
3
4
5
6
7
http \
  PUT \
  https://api.example.com/api/payment-profiles/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-payment-profile" \
  organization="https://api.example.com/api/organization/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  payment_type="fixed_price"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.payment_profile_request import PaymentProfileRequest # (1)
from waldur_api_client.api.payment_profiles import payment_profiles_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PaymentProfileRequest(
    name="my-awesome-payment-profile",
    organization="https://api.example.com/api/organization/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    payment_type="fixed_price"
)
response = payment_profiles_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PaymentProfileRequest
  2. API Source: payment_profiles_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
import { paymentProfilesUpdate } from 'waldur-js-client';

try {
  const response = await paymentProfilesUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-payment-profile",
    "organization": "https://api.example.com/api/organization/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "payment_type": "fixed_price"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
name string ✓
organization string (uri) ✓
attributes object
attributes.end_date string
attributes.agreement_number string
attributes.contract_sum integer
payment_type string ✓
is_active boolean

200 -

Field Type
uuid string (uuid)
url string (uri)
name string
organization_uuid string (uuid)
organization string (uri)
attributes object
attributes.end_date string
attributes.agreement_number string
attributes.contract_sum integer
payment_type string
payment_type_display string
is_active boolean

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/payment-profiles/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_payment_profile_request import PatchedPaymentProfileRequest # (1)
from waldur_api_client.api.payment_profiles import payment_profiles_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedPaymentProfileRequest()
response = payment_profiles_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedPaymentProfileRequest
  2. API Source: payment_profiles_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { paymentProfilesPartialUpdate } from 'waldur-js-client';

try {
  const response = await paymentProfilesPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
name string
organization string (uri)
attributes object
attributes.end_date string
attributes.agreement_number string
attributes.contract_sum integer
payment_type string
is_active boolean

200 -

Field Type
uuid string (uuid)
url string (uri)
name string
organization_uuid string (uuid)
organization string (uri)
attributes object
attributes.end_date string
attributes.agreement_number string
attributes.contract_sum integer
payment_type string
payment_type_display string
is_active boolean

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/payment-profiles/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.payment_profiles import payment_profiles_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = payment_profiles_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: payment_profiles_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { paymentProfilesDestroy } from 'waldur-js-client';

try {
  const response = await paymentProfilesDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Other Actions

Enable

1
2
3
4
http \
  POST \
  https://api.example.com/api/payment-profiles/a1b2c3d4-e5f6-7890-abcd-ef1234567890/enable/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.payment_profiles import payment_profiles_enable # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = payment_profiles_enable.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: payment_profiles_enable
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { paymentProfilesEnable } from 'waldur-js-client';

try {
  const response = await paymentProfilesEnable({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 - No response body

Payments

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/payments/ List Payments
GET /api/payments/{uuid}/ Retrieve
POST /api/payments/ Create
POST /api/payments/{uuid}/unlink_from_invoice/ Unlink from invoice
PUT /api/payments/{uuid}/ Update
PATCH /api/payments/{uuid}/ Partial Update
DELETE /api/payments/{uuid}/ Delete
Other Actions
POST /api/payments/{uuid}/link_to_invoice/ Link to invoice

Core CRUD

List Payments

1
2
3
4
http \
  GET \
  https://api.example.com/api/payments/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.payments import payments_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = payments_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: payments_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { paymentsList } from 'waldur-js-client';

try {
  const response = await paymentsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
date_of_payment string (date)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
profile string (uri)
profile_uuid string (uuid)

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
uuid string (uuid)
url string (uri)
profile string (uri)
date_of_payment string (date)
sum string (decimal)
proof string (uri)
invoice string (uri)
invoice_uuid string (uuid)
invoice_period string
customer_uuid string (uuid)

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/payments/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.payments import payments_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = payments_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: payments_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { paymentsRetrieve } from 'waldur-js-client';

try {
  const response = await paymentsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
uuid string (uuid)
url string (uri)
profile string (uri)
date_of_payment string (date)
sum string (decimal)
proof string (uri)
invoice string (uri)
invoice_uuid string (uuid)
invoice_period string
customer_uuid string (uuid)

Create

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/payments/ \
  Authorization:"Token YOUR_API_TOKEN" \
  profile="https://api.example.com/api/profile/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  date_of_payment="2023-10-01"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.payment_request import PaymentRequest # (1)
from waldur_api_client.api.payments import payments_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PaymentRequest(
    profile="https://api.example.com/api/profile/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    date_of_payment="2023-10-01"
)
response = payments_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PaymentRequest
  2. API Source: payments_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { paymentsCreate } from 'waldur-js-client';

try {
  const response = await paymentsCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "profile": "https://api.example.com/api/profile/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "date_of_payment": "2023-10-01"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required
profile string (uri) ✓
date_of_payment string (date) ✓
sum string (decimal)
proof string (binary)

201 -

Field Type
uuid string (uuid)
url string (uri)
profile string (uri)
date_of_payment string (date)
sum string (decimal)
proof string (uri)
invoice string (uri)
invoice_uuid string (uuid)
invoice_period string
customer_uuid string (uuid)

Unlink a payment from an invoice. Remove connection between payment and existing linked invoice.

1
2
3
4
http \
  POST \
  https://api.example.com/api/payments/a1b2c3d4-e5f6-7890-abcd-ef1234567890/unlink_from_invoice/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.payments import payments_unlink_from_invoice # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = payments_unlink_from_invoice.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: payments_unlink_from_invoice
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { paymentsUnlinkFromInvoice } from 'waldur-js-client';

try {
  const response = await paymentsUnlinkFromInvoice({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 - No response body

Update

1
2
3
4
5
6
http \
  PUT \
  https://api.example.com/api/payments/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  profile="https://api.example.com/api/profile/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  date_of_payment="2023-10-01"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.payment_request import PaymentRequest # (1)
from waldur_api_client.api.payments import payments_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PaymentRequest(
    profile="https://api.example.com/api/profile/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    date_of_payment="2023-10-01"
)
response = payments_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PaymentRequest
  2. API Source: payments_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { paymentsUpdate } from 'waldur-js-client';

try {
  const response = await paymentsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "profile": "https://api.example.com/api/profile/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "date_of_payment": "2023-10-01"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
profile string (uri) ✓
date_of_payment string (date) ✓
sum string (decimal)
proof string (binary)

200 -

Field Type
uuid string (uuid)
url string (uri)
profile string (uri)
date_of_payment string (date)
sum string (decimal)
proof string (uri)
invoice string (uri)
invoice_uuid string (uuid)
invoice_period string
customer_uuid string (uuid)

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/payments/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_payment_request import PatchedPaymentRequest # (1)
from waldur_api_client.api.payments import payments_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedPaymentRequest()
response = payments_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedPaymentRequest
  2. API Source: payments_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { paymentsPartialUpdate } from 'waldur-js-client';

try {
  const response = await paymentsPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
profile string (uri)
date_of_payment string (date)
sum string (decimal)
proof string (binary)

200 -

Field Type
uuid string (uuid)
url string (uri)
profile string (uri)
date_of_payment string (date)
sum string (decimal)
proof string (uri)
invoice string (uri)
invoice_uuid string (uuid)
invoice_period string
customer_uuid string (uuid)

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/payments/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.payments import payments_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = payments_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: payments_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { paymentsDestroy } from 'waldur-js-client';

try {
  const response = await paymentsDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Other Actions

Link a payment to an invoice. Payment can be linked to an invoice only if they belong to the same customer.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/payments/a1b2c3d4-e5f6-7890-abcd-ef1234567890/link_to_invoice/ \
  Authorization:"Token YOUR_API_TOKEN" \
  invoice="https://api.example.com/api/invoice/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.link_to_invoice_request import LinkToInvoiceRequest # (1)
from waldur_api_client.api.payments import payments_link_to_invoice # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = LinkToInvoiceRequest(
    invoice="https://api.example.com/api/invoice/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = payments_link_to_invoice.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: LinkToInvoiceRequest
  2. API Source: payments_link_to_invoice
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { paymentsLinkToInvoice } from 'waldur-js-client';

try {
  const response = await paymentsLinkToInvoice({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "invoice": "https://api.example.com/api/invoice/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
invoice string (uri) ✓

200 -

Field Type
invoice string (uri)

Project Credits

Operations Summary

Method Endpoint Description
GET /api/project-credits/ List Project Credits
GET /api/project-credits/{uuid}/ Retrieve
POST /api/project-credits/ Create
PUT /api/project-credits/{uuid}/ Update
PATCH /api/project-credits/{uuid}/ Partial Update
DELETE /api/project-credits/{uuid}/ Delete

List Project Credits

1
2
3
4
http \
  GET \
  https://api.example.com/api/project-credits/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.project_credit_o_enum import ProjectCreditOEnum # (1)
from waldur_api_client.api.project_credits import project_credits_list # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = project_credits_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: ProjectCreditOEnum
  2. API Source: project_credits_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { projectCreditsList } from 'waldur-js-client';

try {
  const response = await projectCreditsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
customer_name string
customer_slug string
customer_uuid string (uuid)
o array Ordering
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
project_name string
project_uuid string (uuid)
query string

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
uuid string (uuid)
url string (uri)
value string (decimal)
project string (uri)
project_name string
project_uuid string (uuid)
project_slug string
customer_name string
customer_slug string
customer_uuid string (uuid)
customer_credit string (decimal)
allocated_customer_credit number (double)
consumption_last_month number (double)
offerings array of objects
offerings.uuid string (uuid)
offerings.url string (uri)
offerings.type string
offerings.name string
end_date string (date)
expected_consumption string (decimal)
minimal_consumption number (double)
minimal_consumption_logic string
grace_coefficient string (decimal)
apply_as_minimal_consumption boolean
mark_unused_credit_as_spent_on_project_termination boolean

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/project-credits/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.project_credits import project_credits_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = project_credits_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: project_credits_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { projectCreditsRetrieve } from 'waldur-js-client';

try {
  const response = await projectCreditsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
uuid string (uuid)
url string (uri)
value string (decimal)
project string (uri)
project_name string
project_uuid string (uuid)
project_slug string
customer_name string
customer_slug string
customer_uuid string (uuid)
customer_credit string (decimal)
allocated_customer_credit number (double)
consumption_last_month number (double)
offerings array of objects
offerings.uuid string (uuid)
offerings.url string (uri)
offerings.type string
offerings.name string
end_date string (date)
expected_consumption string (decimal)
minimal_consumption number (double)
minimal_consumption_logic string
grace_coefficient string (decimal)
apply_as_minimal_consumption boolean
mark_unused_credit_as_spent_on_project_termination boolean

Create

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/project-credits/ \
  Authorization:"Token YOUR_API_TOKEN" \
  project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.project_credit_request import ProjectCreditRequest # (1)
from waldur_api_client.api.project_credits import project_credits_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ProjectCreditRequest(
    project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = project_credits_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ProjectCreditRequest
  2. API Source: project_credits_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { projectCreditsCreate } from 'waldur-js-client';

try {
  const response = await projectCreditsCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "project": "https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required
value string (decimal)
project string (uri) ✓
end_date string (date)
expected_consumption string (decimal)
minimal_consumption_logic string
grace_coefficient string (decimal)
apply_as_minimal_consumption boolean
mark_unused_credit_as_spent_on_project_termination boolean

201 -

Field Type
uuid string (uuid)
url string (uri)
value string (decimal)
project string (uri)
project_name string
project_uuid string (uuid)
project_slug string
customer_name string
customer_slug string
customer_uuid string (uuid)
customer_credit string (decimal)
allocated_customer_credit number (double)
consumption_last_month number (double)
offerings array of objects
offerings.uuid string (uuid)
offerings.url string (uri)
offerings.type string
offerings.name string
end_date string (date)
expected_consumption string (decimal)
minimal_consumption number (double)
minimal_consumption_logic string
grace_coefficient string (decimal)
apply_as_minimal_consumption boolean
mark_unused_credit_as_spent_on_project_termination boolean

Update

1
2
3
4
5
http \
  PUT \
  https://api.example.com/api/project-credits/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.project_credit_request import ProjectCreditRequest # (1)
from waldur_api_client.api.project_credits import project_credits_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ProjectCreditRequest(
    project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = project_credits_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ProjectCreditRequest
  2. API Source: project_credits_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { projectCreditsUpdate } from 'waldur-js-client';

try {
  const response = await projectCreditsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "project": "https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
value string (decimal)
project string (uri) ✓
end_date string (date)
expected_consumption string (decimal)
minimal_consumption_logic string
grace_coefficient string (decimal)
apply_as_minimal_consumption boolean
mark_unused_credit_as_spent_on_project_termination boolean

200 -

Field Type
uuid string (uuid)
url string (uri)
value string (decimal)
project string (uri)
project_name string
project_uuid string (uuid)
project_slug string
customer_name string
customer_slug string
customer_uuid string (uuid)
customer_credit string (decimal)
allocated_customer_credit number (double)
consumption_last_month number (double)
offerings array of objects
offerings.uuid string (uuid)
offerings.url string (uri)
offerings.type string
offerings.name string
end_date string (date)
expected_consumption string (decimal)
minimal_consumption number (double)
minimal_consumption_logic string
grace_coefficient string (decimal)
apply_as_minimal_consumption boolean
mark_unused_credit_as_spent_on_project_termination boolean

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/project-credits/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_project_credit_request import PatchedProjectCreditRequest # (1)
from waldur_api_client.api.project_credits import project_credits_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedProjectCreditRequest()
response = project_credits_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedProjectCreditRequest
  2. API Source: project_credits_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { projectCreditsPartialUpdate } from 'waldur-js-client';

try {
  const response = await projectCreditsPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
value string (decimal)
project string (uri)
end_date string (date)
expected_consumption string (decimal)
minimal_consumption_logic string
grace_coefficient string (decimal)
apply_as_minimal_consumption boolean
mark_unused_credit_as_spent_on_project_termination boolean

200 -

Field Type
uuid string (uuid)
url string (uri)
value string (decimal)
project string (uri)
project_name string
project_uuid string (uuid)
project_slug string
customer_name string
customer_slug string
customer_uuid string (uuid)
customer_credit string (decimal)
allocated_customer_credit number (double)
consumption_last_month number (double)
offerings array of objects
offerings.uuid string (uuid)
offerings.url string (uri)
offerings.type string
offerings.name string
end_date string (date)
expected_consumption string (decimal)
minimal_consumption number (double)
minimal_consumption_logic string
grace_coefficient string (decimal)
apply_as_minimal_consumption boolean
mark_unused_credit_as_spent_on_project_termination boolean

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/project-credits/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.project_credits import project_credits_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = project_credits_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: project_credits_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { projectCreditsDestroy } from 'waldur-js-client';

try {
  const response = await projectCreditsDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Provider Invoice Items

Operations Summary

Method Endpoint Description
GET /api/provider-invoice-items/ List Provider Invoice Items
GET /api/provider-invoice-items/{id}/ Retrieve

List Provider Invoice Items

1
2
3
4
http \
  GET \
  https://api.example.com/api/provider-invoice-items/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.invoice_item_o_enum1 import InvoiceItemOEnum1 # (1)
from waldur_api_client.api.provider_invoice_items import provider_invoice_items_list # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = provider_invoice_items_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: InvoiceItemOEnum1
  2. API Source: provider_invoice_items_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { providerInvoiceItemsList } from 'waldur-js-client';

try {
  const response = await providerInvoiceItemsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
customer_uuid string (uuid) Customer UUID
invoice_month integer Invoice month
invoice_year integer Invoice year
o array Ordering
offering_uuid string (uuid) Offering UUID
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
project_uuid string (uuid) Project UUID

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid)
url string (uri)
name string
price number (double)
tax string (decimal)
total string (decimal)
unit_price string (decimal)
unit string
Enum: month, quarter, half_month, day, hour, quantity
factor integer
measured_unit string
start string (date-time) Date and time when item usage has started.
end string (date-time) Date and time when item usage has ended.
article_code string
project_name string
project_uuid string (uuid)
quantity string (decimal)
details object
details.resource_name string Name of the marketplace resource
details.resource_uuid string (uuid) UUID of the marketplace resource
details.plan_name string Name of the pricing plan
details.plan_uuid string (uuid) UUID of the pricing plan
details.offering_type string Type of the offering
details.offering_name string Name of the offering
details.offering_uuid string (uuid) UUID of the offering
details.service_provider_name string Name of the service provider
details.service_provider_uuid string (uuid) UUID of the service provider
details.plan_component_id integer ID of the plan component
details.offering_component_type string Type of the offering component
details.offering_component_name string Name of the offering component
details.resource_limit_periods array of objects List of resource limit periods for this invoice item
details.resource_limit_periods.start string Start date of the resource limit period
details.resource_limit_periods.end string End date of the resource limit period
details.resource_limit_periods.quantity integer Quantity of resources consumed during this period
details.resource_limit_periods.billing_periods integer Number of billing periods
details.resource_limit_periods.total string Total amount for this period
resource string (uri)
resource_uuid string (uuid)
resource_name string
billing_type string
backend_uuid string (uuid)
credit boolean

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/provider-invoice-items/123/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.provider_invoice_items import provider_invoice_items_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = provider_invoice_items_retrieve.sync(
    id=123,
    client=client
)

print(response)
  1. API Source: provider_invoice_items_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { providerInvoiceItemsRetrieve } from 'waldur-js-client';

try {
  const response = await providerInvoiceItemsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "id": 123
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
id integer ✓ A unique integer value identifying this invoice item.

200 -

Field Type Description
uuid string (uuid)
url string (uri)
name string
price number (double)
tax string (decimal)
total string (decimal)
unit_price string (decimal)
unit string
Enum: month, quarter, half_month, day, hour, quantity
factor integer
measured_unit string
start string (date-time) Date and time when item usage has started.
end string (date-time) Date and time when item usage has ended.
article_code string
project_name string
project_uuid string (uuid)
quantity string (decimal)
details object
details.resource_name string Name of the marketplace resource
details.resource_uuid string (uuid) UUID of the marketplace resource
details.plan_name string Name of the pricing plan
details.plan_uuid string (uuid) UUID of the pricing plan
details.offering_type string Type of the offering
details.offering_name string Name of the offering
details.offering_uuid string (uuid) UUID of the offering
details.service_provider_name string Name of the service provider
details.service_provider_uuid string (uuid) UUID of the service provider
details.plan_component_id integer ID of the plan component
details.offering_component_type string Type of the offering component
details.offering_component_name string Name of the offering component
details.resource_limit_periods array of objects List of resource limit periods for this invoice item
details.resource_limit_periods.start string Start date of the resource limit period
details.resource_limit_periods.end string End date of the resource limit period
details.resource_limit_periods.quantity integer Quantity of resources consumed during this period
details.resource_limit_periods.billing_periods integer Number of billing periods
details.resource_limit_periods.total string Total amount for this period
resource string (uri)
resource_uuid string (uuid)
resource_name string
billing_type string
backend_uuid string (uuid)
credit boolean

Reporting and analytics

Billing Total Cost

Operations Summary

Method Endpoint Description
GET /api/billing-total-cost/ List Billing Total Cost

List Billing Total Cost

1
2
3
4
http \
  GET \
  https://api.example.com/api/billing-total-cost/ \
  Authorization:"Token YOUR_API_TOKEN"

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.billing_total_cost import billing_total_cost_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = billing_total_cost_retrieve.sync(client=client)

print(response)
  1. API Source: billing_total_cost_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { billingTotalCostRetrieve } from 'waldur-js-client';

try {
  const response = await billingTotalCostRetrieve({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type
accounting_is_running boolean
customer_uuid string (uuid)
month integer
name string
year integer

200 -

Field Type
total number (double)
price number (double)

Customer Quotas

Operations Summary

Method Endpoint Description
GET /api/customer-quotas/ List customer quotas

List customer quotas

List customer quotas.

1
2
3
4
http \
  GET \
  https://api.example.com/api/customer-quotas/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.customer_quotas import customer_quotas_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = customer_quotas_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: customer_quotas_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { customerQuotasList } from 'waldur-js-client';

try {
  const response = await customerQuotasList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
customer_name string
customer_abbreviation string
value integer

Daily Quotas

Operations Summary

Method Endpoint Description
GET /api/daily-quotas/ List Daily Quotas

List Daily Quotas

1
2
3
4
http \
  GET \
  https://api.example.com/api/daily-quotas/ \
  Authorization:"Token YOUR_API_TOKEN"

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.daily_quotas import daily_quotas_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = daily_quotas_retrieve.sync(client=client)

print(response)
  1. API Source: daily_quotas_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { dailyQuotasRetrieve } from 'waldur-js-client';

try {
  const response = await dailyQuotasRetrieve({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
end string (date) End date in format YYYY-MM-DD
quota_names array List of quota names
scope string (uuid) UUID of the scope object
start string (date) Start date in format YYYY-MM-DD

200 -

Financial Reports

Operations Summary

Method Endpoint Description
GET /api/financial-reports/ List Financial Reports
GET /api/financial-reports/{uuid}/ Retrieve

List Financial Reports

1
2
3
4
http \
  GET \
  https://api.example.com/api/financial-reports/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.financial_reports import financial_reports_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = financial_reports_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: financial_reports_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { financialReportsList } from 'waldur-js-client';

try {
  const response = await financialReportsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
abbreviation string Abbreviation
accounting_is_running boolean Filter by whether accounting is running.
agreement_number string
archived boolean
backend_id string
contact_details string Contact details
current_user_has_project_create_permission boolean Return a list of customers where current user has project create permission.
customer_uuid string (uuid) Filter by customer UUID.
month integer Filter by month.
name string Name
name_exact string Name (exact)
native_name string Native name
o string Which field to use when ordering the results.
organization_group_name string Organization group name
organization_group_uuid array Organization group UUID
owned_by_current_user boolean Return a list of customers where current user is owner.
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
query string Filter by name, native name, abbreviation, domain, UUID, registration code or agreement number
registration_code string
year integer Filter by year.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
name string
uuid string (uuid)
abbreviation string
created string (date-time)
accounting_start_date string (date-time)
registration_code string
agreement_number string
payment_profiles array of objects
payment_profiles.uuid string (uuid)
payment_profiles.url string (uri)
payment_profiles.name string
payment_profiles.organization_uuid string (uuid)
payment_profiles.organization string (uri)
payment_profiles.attributes object
payment_profiles.attributes.end_date string
payment_profiles.attributes.agreement_number string
payment_profiles.attributes.contract_sum integer
payment_profiles.payment_type string
payment_profiles.payment_type_display string
payment_profiles.is_active boolean
billing_price_estimate any

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/financial-reports/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.financial_reports import financial_reports_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = financial_reports_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: financial_reports_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { financialReportsRetrieve } from 'waldur-js-client';

try {
  const response = await financialReportsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
name string
uuid string (uuid)
abbreviation string
created string (date-time)
accounting_start_date string (date-time)
registration_code string
agreement_number string
payment_profiles array of objects
payment_profiles.uuid string (uuid)
payment_profiles.url string (uri)
payment_profiles.name string
payment_profiles.organization_uuid string (uuid)
payment_profiles.organization string (uri)
payment_profiles.attributes object
payment_profiles.attributes.end_date string
payment_profiles.attributes.agreement_number string
payment_profiles.attributes.contract_sum integer
payment_profiles.payment_type string
payment_profiles.payment_type_display string
payment_profiles.is_active boolean
billing_price_estimate any

Project Quotas

Operations Summary

Method Endpoint Description
GET /api/project-quotas/ List project quotas

List project quotas

List project quotas.

1
2
3
4
http \
  GET \
  https://api.example.com/api/project-quotas/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.project_quotas import project_quotas_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = project_quotas_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: project_quotas_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { projectQuotasList } from 'waldur-js-client';

try {
  const response = await projectQuotasList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
project_name string
customer_name string
customer_abbreviation string
value integer

Cloud and hpc providers

Aws

Aws Images

Operations Summary

Method Endpoint Description
GET /api/aws-images/ List Aws Images
GET /api/aws-images/{uuid}/ Retrieve

List Aws Images

1
2
3
4
http \
  GET \
  https://api.example.com/api/aws-images/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.aws_images import aws_images_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = aws_images_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: aws_images_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { awsImagesList } from 'waldur-js-client';

try {
  const response = await awsImagesList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
name string Name
name_exact string Name (exact)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
region string (uuid)

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
url string (uri)
uuid string (uuid)
name string
region any

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/aws-images/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.aws_images import aws_images_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = aws_images_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: aws_images_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { awsImagesRetrieve } from 'waldur-js-client';

try {
  const response = await awsImagesRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
url string (uri)
uuid string (uuid)
name string
region any

Aws Instances

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/aws-instances/ List Aws Instances
GET /api/aws-instances/{uuid}/ Retrieve
POST /api/aws-instances/ Create
POST /api/aws-instances/{uuid}/pull/ Synchronize resource state
POST /api/aws-instances/{uuid}/unlink/ Unlink resource
PUT /api/aws-instances/{uuid}/ Update
PATCH /api/aws-instances/{uuid}/ Partial Update
DELETE /api/aws-instances/{uuid}/ Delete
Other Actions
POST /api/aws-instances/{uuid}/resize/ Resize
POST /api/aws-instances/{uuid}/restart/ Restart
POST /api/aws-instances/{uuid}/set_erred/ Mark resource as ERRED
POST /api/aws-instances/{uuid}/set_ok/ Mark resource as OK
POST /api/aws-instances/{uuid}/start/ Start
POST /api/aws-instances/{uuid}/stop/ Stop

Core CRUD

List Aws Instances

1
2
3
4
http \
  GET \
  https://api.example.com/api/aws-instances/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.aws_instance_field_enum import AwsInstanceFieldEnum # (1)
from waldur_api_client.models.core_states import CoreStates # (2)
from waldur_api_client.api.aws_instances import aws_instances_list # (3)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = aws_instances_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: AwsInstanceFieldEnum
  2. Model Source: CoreStates
  3. API Source: aws_instances_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { awsInstancesList } from 'waldur-js-client';

try {
  const response = await awsInstancesList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
backend_id string Backend ID
can_manage boolean Can manage
customer string (uuid) Customer UUID
customer_abbreviation string Customer abbreviation
customer_name string Customer name
customer_native_name string Customer native name
customer_uuid string (uuid) Customer UUID
description string Description
external_ip string
field array
name string Name
name_exact string Name (exact)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
project string (uuid) Project UUID
project_name string Project name
project_uuid string (uuid) Project UUID
service_settings_name string Service settings name
service_settings_uuid string (uuid) Service settings UUID
state array State
uuid string (uuid) UUID

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
start_time string (date-time)
cores integer Number of cores in a VM
ram integer Memory size in MiB
disk integer Disk size in MiB
min_ram integer Minimum memory size in MiB
min_disk integer Minimum disk size in MiB
user_data string Additional data that will be added to instance on provisioning
external_ips array of string (ipv4)s
internal_ips array of string (ipv4)s
latitude number (double)
longitude number (double)
key_name string
key_fingerprint string
image_name string
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/aws-instances/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.aws_instance_field_enum import AwsInstanceFieldEnum # (1)
from waldur_api_client.api.aws_instances import aws_instances_retrieve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = aws_instances_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. Model Source: AwsInstanceFieldEnum
  2. API Source: aws_instances_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { awsInstancesRetrieve } from 'waldur-js-client';

try {
  const response = await awsInstancesRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type
field array

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
start_time string (date-time)
cores integer Number of cores in a VM
ram integer Memory size in MiB
disk integer Disk size in MiB
min_ram integer Minimum memory size in MiB
min_disk integer Minimum disk size in MiB
user_data string Additional data that will be added to instance on provisioning
external_ips array of string (ipv4)s
internal_ips array of string (ipv4)s
latitude number (double)
longitude number (double)
key_name string
key_fingerprint string
image_name string
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Create

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
http \
  POST \
  https://api.example.com/api/aws-instances/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-aws-instance" \
  service_settings="https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  region="https://api.example.com/api/region/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  image="https://api.example.com/api/image/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  size=100

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.aws_instance_request import AwsInstanceRequest # (1)
from waldur_api_client.api.aws_instances import aws_instances_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = AwsInstanceRequest(
    name="my-awesome-aws-instance",
    service_settings="https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    region="https://api.example.com/api/region/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    image="https://api.example.com/api/image/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    size=100
)
response = aws_instances_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: AwsInstanceRequest
  2. API Source: aws_instances_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
import { awsInstancesCreate } from 'waldur-js-client';

try {
  const response = await awsInstancesCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "name": "my-awesome-aws-instance",
    "service_settings": "https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "project": "https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "region": "https://api.example.com/api/region/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "image": "https://api.example.com/api/image/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "size": 100
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
name string ✓
description string
service_settings string (uri) ✓
project string (uri) ✓
ssh_public_key string (uri)
Constraints: write-only
user_data string Additional data that will be added to instance on provisioning
region string (uri) ✓
Constraints: write-only
image string (uri) ✓
Constraints: write-only
size string (uri) ✓
Constraints: write-only

201 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
start_time string (date-time)
cores integer Number of cores in a VM
ram integer Memory size in MiB
disk integer Disk size in MiB
min_ram integer Minimum memory size in MiB
min_disk integer Minimum disk size in MiB
user_data string Additional data that will be added to instance on provisioning
external_ips array of string (ipv4)s
internal_ips array of string (ipv4)s
latitude number (double)
longitude number (double)
key_name string
key_fingerprint string
image_name string
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Synchronize resource state

Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.

1
2
3
4
http \
  POST \
  https://api.example.com/api/aws-instances/a1b2c3d4-e5f6-7890-abcd-ef1234567890/pull/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.aws_instances import aws_instances_pull # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = aws_instances_pull.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: aws_instances_pull
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { awsInstancesPull } from 'waldur-js-client';

try {
  const response = await awsInstancesPull({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

202 -

Field Type
detail string

409 -

Field Type
detail string

Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state.

1
2
3
4
http \
  POST \
  https://api.example.com/api/aws-instances/a1b2c3d4-e5f6-7890-abcd-ef1234567890/unlink/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.aws_instances import aws_instances_unlink # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = aws_instances_unlink.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: aws_instances_unlink
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { awsInstancesUnlink } from 'waldur-js-client';

try {
  const response = await awsInstancesUnlink({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Update

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
http \
  PUT \
  https://api.example.com/api/aws-instances/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-aws-instance" \
  service_settings="https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  region="https://api.example.com/api/region/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  image="https://api.example.com/api/image/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  size=100

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.aws_instance_request import AwsInstanceRequest # (1)
from waldur_api_client.api.aws_instances import aws_instances_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = AwsInstanceRequest(
    name="my-awesome-aws-instance",
    service_settings="https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    region="https://api.example.com/api/region/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    image="https://api.example.com/api/image/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    size=100
)
response = aws_instances_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: AwsInstanceRequest
  2. API Source: aws_instances_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
import { awsInstancesUpdate } from 'waldur-js-client';

try {
  const response = await awsInstancesUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-aws-instance",
    "service_settings": "https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "project": "https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "region": "https://api.example.com/api/region/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "image": "https://api.example.com/api/image/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "size": 100
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
name string ✓
description string
service_settings string (uri) ✓
project string (uri) ✓
ssh_public_key string (uri)
Constraints: write-only
user_data string Additional data that will be added to instance on provisioning
region string (uri) ✓
Constraints: write-only
image string (uri) ✓
Constraints: write-only
size string (uri) ✓
Constraints: write-only

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
start_time string (date-time)
cores integer Number of cores in a VM
ram integer Memory size in MiB
disk integer Disk size in MiB
min_ram integer Minimum memory size in MiB
min_disk integer Minimum disk size in MiB
user_data string Additional data that will be added to instance on provisioning
external_ips array of string (ipv4)s
internal_ips array of string (ipv4)s
latitude number (double)
longitude number (double)
key_name string
key_fingerprint string
image_name string
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/aws-instances/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_aws_instance_request import PatchedAwsInstanceRequest # (1)
from waldur_api_client.api.aws_instances import aws_instances_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedAwsInstanceRequest()
response = aws_instances_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedAwsInstanceRequest
  2. API Source: aws_instances_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { awsInstancesPartialUpdate } from 'waldur-js-client';

try {
  const response = await awsInstancesPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
name string
description string

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
start_time string (date-time)
cores integer Number of cores in a VM
ram integer Memory size in MiB
disk integer Disk size in MiB
min_ram integer Minimum memory size in MiB
min_disk integer Minimum disk size in MiB
user_data string Additional data that will be added to instance on provisioning
external_ips array of string (ipv4)s
internal_ips array of string (ipv4)s
latitude number (double)
longitude number (double)
key_name string
key_fingerprint string
image_name string
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/aws-instances/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.aws_instances import aws_instances_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = aws_instances_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: aws_instances_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { awsInstancesDestroy } from 'waldur-js-client';

try {
  const response = await awsInstancesDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Other Actions

Resize

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/aws-instances/a1b2c3d4-e5f6-7890-abcd-ef1234567890/resize/ \
  Authorization:"Token YOUR_API_TOKEN" \
  size=100

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.aws_instance_resize_request import AwsInstanceResizeRequest # (1)
from waldur_api_client.api.aws_instances import aws_instances_resize # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = AwsInstanceResizeRequest(
    size=100
)
response = aws_instances_resize.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: AwsInstanceResizeRequest
  2. API Source: aws_instances_resize
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { awsInstancesResize } from 'waldur-js-client';

try {
  const response = await awsInstancesResize({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "size": 100
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
size string (uri) ✓

200 -

Field Type
size string (uri)

Restart

1
2
3
4
http \
  POST \
  https://api.example.com/api/aws-instances/a1b2c3d4-e5f6-7890-abcd-ef1234567890/restart/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.aws_instances import aws_instances_restart # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = aws_instances_restart.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: aws_instances_restart
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { awsInstancesRestart } from 'waldur-js-client';

try {
  const response = await awsInstancesRestart({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 - No response body

Mark resource as ERRED

Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.

1
2
3
4
http \
  POST \
  https://api.example.com/api/aws-instances/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_erred/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.set_erred_request import SetErredRequest # (1)
from waldur_api_client.api.aws_instances import aws_instances_set_erred # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = SetErredRequest()
response = aws_instances_set_erred.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: SetErredRequest
  2. API Source: aws_instances_set_erred
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { awsInstancesSetErred } from 'waldur-js-client';

try {
  const response = await awsInstancesSetErred({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
error_message string
error_traceback string

200 -

Field Type
detail string

Mark resource as OK

Manually transition the resource to OK state and clear error fields. Staff-only operation.

1
2
3
4
http \
  POST \
  https://api.example.com/api/aws-instances/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_ok/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.aws_instances import aws_instances_set_ok # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = aws_instances_set_ok.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: aws_instances_set_ok
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { awsInstancesSetOk } from 'waldur-js-client';

try {
  const response = await awsInstancesSetOk({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
detail string

Start

1
2
3
4
http \
  POST \
  https://api.example.com/api/aws-instances/a1b2c3d4-e5f6-7890-abcd-ef1234567890/start/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.aws_instances import aws_instances_start # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = aws_instances_start.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: aws_instances_start
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { awsInstancesStart } from 'waldur-js-client';

try {
  const response = await awsInstancesStart({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 - No response body

Stop

1
2
3
4
http \
  POST \
  https://api.example.com/api/aws-instances/a1b2c3d4-e5f6-7890-abcd-ef1234567890/stop/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.aws_instances import aws_instances_stop # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = aws_instances_stop.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: aws_instances_stop
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { awsInstancesStop } from 'waldur-js-client';

try {
  const response = await awsInstancesStop({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 - No response body

Aws Regions

Operations Summary

Method Endpoint Description
GET /api/aws-regions/ List Aws Regions
GET /api/aws-regions/{uuid}/ Retrieve

List Aws Regions

1
2
3
4
http \
  GET \
  https://api.example.com/api/aws-regions/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.aws_regions import aws_regions_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = aws_regions_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: aws_regions_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { awsRegionsList } from 'waldur-js-client';

try {
  const response = await awsRegionsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
name string Name
name_exact string Name (exact)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
url string (uri)
uuid string (uuid)
name string

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/aws-regions/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.aws_regions import aws_regions_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = aws_regions_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: aws_regions_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { awsRegionsRetrieve } from 'waldur-js-client';

try {
  const response = await awsRegionsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
url string (uri)
uuid string (uuid)
name string

Aws Sizes

Operations Summary

Method Endpoint Description
GET /api/aws-sizes/ List Aws Sizes
GET /api/aws-sizes/{uuid}/ Retrieve

List Aws Sizes

1
2
3
4
http \
  GET \
  https://api.example.com/api/aws-sizes/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.aws_sizes import aws_sizes_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = aws_sizes_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: aws_sizes_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { awsSizesList } from 'waldur-js-client';

try {
  const response = await awsSizesList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
name string Name
name_exact string Name (exact)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
region string (uuid)

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
name string
cores integer Number of cores in a VM
ram integer Memory size in MiB
disk integer Disk size in MiB
regions array of objects
regions.url string (uri)
regions.uuid string (uuid)
regions.name string
description string

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/aws-sizes/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.aws_sizes import aws_sizes_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = aws_sizes_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: aws_sizes_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { awsSizesRetrieve } from 'waldur-js-client';

try {
  const response = await awsSizesRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
cores integer Number of cores in a VM
ram integer Memory size in MiB
disk integer Disk size in MiB
regions array of objects
regions.url string (uri)
regions.uuid string (uuid)
regions.name string
description string

Aws Volumes

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/aws-volumes/ List Aws Volumes
GET /api/aws-volumes/{uuid}/ Retrieve
POST /api/aws-volumes/ Create
POST /api/aws-volumes/{uuid}/pull/ Synchronize resource state
POST /api/aws-volumes/{uuid}/unlink/ Unlink resource
PUT /api/aws-volumes/{uuid}/ Update
PATCH /api/aws-volumes/{uuid}/ Partial Update
DELETE /api/aws-volumes/{uuid}/ Delete
Other Actions
POST /api/aws-volumes/{uuid}/attach/ Attach
POST /api/aws-volumes/{uuid}/detach/ Detach
POST /api/aws-volumes/{uuid}/set_erred/ Mark resource as ERRED
POST /api/aws-volumes/{uuid}/set_ok/ Mark resource as OK

Core CRUD

List Aws Volumes

1
2
3
4
http \
  GET \
  https://api.example.com/api/aws-volumes/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.aws_volume_field_enum import AwsVolumeFieldEnum # (1)
from waldur_api_client.api.aws_volumes import aws_volumes_list # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = aws_volumes_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: AwsVolumeFieldEnum
  2. API Source: aws_volumes_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { awsVolumesList } from 'waldur-js-client';

try {
  const response = await awsVolumesList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
field array
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
size integer Size of volume in gigabytes
volume_type string
Enum: gp2, io1, standard
device string
instance string (uri)
runtime_state string
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/aws-volumes/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.aws_volume_field_enum import AwsVolumeFieldEnum # (1)
from waldur_api_client.api.aws_volumes import aws_volumes_retrieve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = aws_volumes_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. Model Source: AwsVolumeFieldEnum
  2. API Source: aws_volumes_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { awsVolumesRetrieve } from 'waldur-js-client';

try {
  const response = await awsVolumesRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type
field array

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
size integer Size of volume in gigabytes
volume_type string
Enum: gp2, io1, standard
device string
instance string (uri)
runtime_state string
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Create

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
http \
  POST \
  https://api.example.com/api/aws-volumes/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-aws-volume" \
  service_settings="https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  size=100 \
  region="https://api.example.com/api/region/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  volume_type="gp2"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.aws_volume_request import AwsVolumeRequest # (1)
from waldur_api_client.api.aws_volumes import aws_volumes_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = AwsVolumeRequest(
    name="my-awesome-aws-volume",
    service_settings="https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    size=100,
    region="https://api.example.com/api/region/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    volume_type="gp2"
)
response = aws_volumes_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: AwsVolumeRequest
  2. API Source: aws_volumes_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
import { awsVolumesCreate } from 'waldur-js-client';

try {
  const response = await awsVolumesCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "name": "my-awesome-aws-volume",
    "service_settings": "https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "project": "https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "size": 100,
    "region": "https://api.example.com/api/region/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "volume_type": "gp2"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
name string ✓
description string
service_settings string (uri) ✓
project string (uri) ✓
size integer ✓ Size of volume in gigabytes
region string (uri) ✓
Constraints: write-only
volume_type string ✓
Enum: gp2, io1, standard

201 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
size integer Size of volume in gigabytes
volume_type string
Enum: gp2, io1, standard
device string
instance string (uri)
runtime_state string
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Synchronize resource state

Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.

1
2
3
4
http \
  POST \
  https://api.example.com/api/aws-volumes/a1b2c3d4-e5f6-7890-abcd-ef1234567890/pull/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.aws_volumes import aws_volumes_pull # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = aws_volumes_pull.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: aws_volumes_pull
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { awsVolumesPull } from 'waldur-js-client';

try {
  const response = await awsVolumesPull({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

202 -

Field Type
detail string

409 -

Field Type
detail string

Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state.

1
2
3
4
http \
  POST \
  https://api.example.com/api/aws-volumes/a1b2c3d4-e5f6-7890-abcd-ef1234567890/unlink/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.aws_volumes import aws_volumes_unlink # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = aws_volumes_unlink.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: aws_volumes_unlink
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { awsVolumesUnlink } from 'waldur-js-client';

try {
  const response = await awsVolumesUnlink({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Update

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
http \
  PUT \
  https://api.example.com/api/aws-volumes/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-aws-volume" \
  service_settings="https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  size=100 \
  region="https://api.example.com/api/region/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  volume_type="gp2"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.aws_volume_request import AwsVolumeRequest # (1)
from waldur_api_client.api.aws_volumes import aws_volumes_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = AwsVolumeRequest(
    name="my-awesome-aws-volume",
    service_settings="https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    size=100,
    region="https://api.example.com/api/region/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    volume_type="gp2"
)
response = aws_volumes_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: AwsVolumeRequest
  2. API Source: aws_volumes_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
import { awsVolumesUpdate } from 'waldur-js-client';

try {
  const response = await awsVolumesUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-aws-volume",
    "service_settings": "https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "project": "https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "size": 100,
    "region": "https://api.example.com/api/region/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "volume_type": "gp2"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
name string ✓
description string
service_settings string (uri) ✓
project string (uri) ✓
size integer ✓ Size of volume in gigabytes
region string (uri) ✓
Constraints: write-only
volume_type string ✓
Enum: gp2, io1, standard

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
size integer Size of volume in gigabytes
volume_type string
Enum: gp2, io1, standard
device string
instance string (uri)
runtime_state string
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/aws-volumes/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.aws_volumes import aws_volumes_partial_update # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = aws_volumes_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: aws_volumes_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { awsVolumesPartialUpdate } from 'waldur-js-client';

try {
  const response = await awsVolumesPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
size integer Size of volume in gigabytes
volume_type string
Enum: gp2, io1, standard
device string
instance string (uri)
runtime_state string
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/aws-volumes/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.aws_volumes import aws_volumes_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = aws_volumes_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: aws_volumes_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { awsVolumesDestroy } from 'waldur-js-client';

try {
  const response = await awsVolumesDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Other Actions

Attach

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/aws-volumes/a1b2c3d4-e5f6-7890-abcd-ef1234567890/attach/ \
  Authorization:"Token YOUR_API_TOKEN" \
  instance="https://api.example.com/api/instance/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  device="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.aws_volume_attach_request import AwsVolumeAttachRequest # (1)
from waldur_api_client.api.aws_volumes import aws_volumes_attach # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = AwsVolumeAttachRequest(
    instance="https://api.example.com/api/instance/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    device="string-value"
)
response = aws_volumes_attach.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: AwsVolumeAttachRequest
  2. API Source: aws_volumes_attach
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { awsVolumesAttach } from 'waldur-js-client';

try {
  const response = await awsVolumesAttach({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "instance": "https://api.example.com/api/instance/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "device": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
instance string (uri) ✓
device string ✓ The device name for attachment. For example, use /dev/sd[f-p] for Linux instances.

200 -

Field Type Description
instance string (uri)
device string The device name for attachment. For example, use /dev/sd[f-p] for Linux instances.

Detach

1
2
3
4
http \
  POST \
  https://api.example.com/api/aws-volumes/a1b2c3d4-e5f6-7890-abcd-ef1234567890/detach/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.aws_volumes import aws_volumes_detach # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = aws_volumes_detach.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: aws_volumes_detach
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { awsVolumesDetach } from 'waldur-js-client';

try {
  const response = await awsVolumesDetach({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 - No response body

Mark resource as ERRED

Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.

1
2
3
4
http \
  POST \
  https://api.example.com/api/aws-volumes/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_erred/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.set_erred_request import SetErredRequest # (1)
from waldur_api_client.api.aws_volumes import aws_volumes_set_erred # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = SetErredRequest()
response = aws_volumes_set_erred.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: SetErredRequest
  2. API Source: aws_volumes_set_erred
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { awsVolumesSetErred } from 'waldur-js-client';

try {
  const response = await awsVolumesSetErred({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
error_message string
error_traceback string

200 -

Field Type
detail string

Mark resource as OK

Manually transition the resource to OK state and clear error fields. Staff-only operation.

1
2
3
4
http \
  POST \
  https://api.example.com/api/aws-volumes/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_ok/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.aws_volumes import aws_volumes_set_ok # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = aws_volumes_set_ok.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: aws_volumes_set_ok
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { awsVolumesSetOk } from 'waldur-js-client';

try {
  const response = await awsVolumesSetOk({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
detail string

Azure

Azure Images

Operations Summary

Method Endpoint Description
GET /api/azure-images/ List Azure Images
GET /api/azure-images/{uuid}/ Retrieve

List Azure Images

1
2
3
4
http \
  GET \
  https://api.example.com/api/azure-images/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.azure_images import azure_images_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = azure_images_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: azure_images_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { azureImagesList } from 'waldur-js-client';

try {
  const response = await azureImagesList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
location string (uri)
location_uuid string (uuid)
name string Name
name_exact string Name (exact)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
settings string (uri) Settings URL
settings_uuid string (uuid) Settings UUID

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
url string (uri)
uuid string (uuid)
publisher string
name string
sku string
version string

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/azure-images/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.azure_images import azure_images_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = azure_images_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: azure_images_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { azureImagesRetrieve } from 'waldur-js-client';

try {
  const response = await azureImagesRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
url string (uri)
uuid string (uuid)
publisher string
name string
sku string
version string

Azure Locations

Operations Summary

Method Endpoint Description
GET /api/azure-locations/ List Azure Locations
GET /api/azure-locations/{uuid}/ Retrieve

List Azure Locations

1
2
3
4
http \
  GET \
  https://api.example.com/api/azure-locations/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.azure_locations import azure_locations_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = azure_locations_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: azure_locations_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { azureLocationsList } from 'waldur-js-client';

try {
  const response = await azureLocationsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
has_sizes boolean
name string Name
name_exact string Name (exact)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
settings string (uri) Settings URL
settings_uuid string (uuid) Settings UUID

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
url string (uri)
uuid string (uuid)
name string
latitude number (double)
longitude number (double)

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/azure-locations/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.azure_locations import azure_locations_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = azure_locations_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: azure_locations_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { azureLocationsRetrieve } from 'waldur-js-client';

try {
  const response = await azureLocationsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
url string (uri)
uuid string (uuid)
name string
latitude number (double)
longitude number (double)

Azure Public Ips

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/azure-public-ips/ List Azure Public Ips
GET /api/azure-public-ips/{uuid}/ Retrieve
POST /api/azure-public-ips/ Create
POST /api/azure-public-ips/{uuid}/pull/ Synchronize resource state
POST /api/azure-public-ips/{uuid}/unlink/ Unlink resource
PUT /api/azure-public-ips/{uuid}/ Update
PATCH /api/azure-public-ips/{uuid}/ Partial Update
DELETE /api/azure-public-ips/{uuid}/ Delete
Other Actions
POST /api/azure-public-ips/{uuid}/set_erred/ Mark resource as ERRED
POST /api/azure-public-ips/{uuid}/set_ok/ Mark resource as OK

Core CRUD

List Azure Public Ips

1
2
3
4
http \
  GET \
  https://api.example.com/api/azure-public-ips/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.azure_public_ip_field_enum import AzurePublicIPFieldEnum # (1)
from waldur_api_client.models.core_states import CoreStates # (2)
from waldur_api_client.api.azure_public_ips import azure_public_ips_list # (3)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = azure_public_ips_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: AzurePublicIPFieldEnum
  2. Model Source: CoreStates
  3. API Source: azure_public_ips_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { azurePublicIpsList } from 'waldur-js-client';

try {
  const response = await azurePublicIpsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
backend_id string Backend ID
can_manage boolean Can manage
customer string (uuid) Customer UUID
customer_abbreviation string Customer abbreviation
customer_name string Customer name
customer_native_name string Customer native name
customer_uuid string (uuid) Customer UUID
description string Description
external_ip string External IP
field array
name string Name
name_exact string Name (exact)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
project string (uuid) Project UUID
project_name string Project name
project_uuid string (uuid) Project UUID
resource_group string (uri)
resource_group_uuid string (uuid)
service_settings_name string Service settings name
service_settings_uuid string (uuid) Service settings UUID
state array State
uuid string (uuid) UUID

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
location string (uri)
resource_group string (uri)
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/azure-public-ips/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.azure_public_ip_field_enum import AzurePublicIPFieldEnum # (1)
from waldur_api_client.api.azure_public_ips import azure_public_ips_retrieve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = azure_public_ips_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. Model Source: AzurePublicIPFieldEnum
  2. API Source: azure_public_ips_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { azurePublicIpsRetrieve } from 'waldur-js-client';

try {
  const response = await azurePublicIpsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type
field array

200 -

Field Type
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
location string (uri)
resource_group string (uri)
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Create

1
2
3
4
5
6
7
8
9
http \
  POST \
  https://api.example.com/api/azure-public-ips/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-azure-public-ip" \
  service_settings="https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  location="https://api.example.com/api/location/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  resource_group="https://api.example.com/api/resource-group/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.azure_public_ip_request import AzurePublicIPRequest # (1)
from waldur_api_client.api.azure_public_ips import azure_public_ips_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = AzurePublicIPRequest(
    name="my-awesome-azure-public-ip",
    service_settings="https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    location="https://api.example.com/api/location/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    resource_group="https://api.example.com/api/resource-group/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = azure_public_ips_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: AzurePublicIPRequest
  2. API Source: azure_public_ips_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { azurePublicIpsCreate } from 'waldur-js-client';

try {
  const response = await azurePublicIpsCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "name": "my-awesome-azure-public-ip",
    "service_settings": "https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "project": "https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "location": "https://api.example.com/api/location/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "resource_group": "https://api.example.com/api/resource-group/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required
name string ✓
description string
service_settings string (uri) ✓
project string (uri) ✓
location string (uri) ✓
resource_group string (uri) ✓

201 -

Field Type
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
location string (uri)
resource_group string (uri)
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Synchronize resource state

Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.

1
2
3
4
http \
  POST \
  https://api.example.com/api/azure-public-ips/a1b2c3d4-e5f6-7890-abcd-ef1234567890/pull/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.azure_public_ips import azure_public_ips_pull # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = azure_public_ips_pull.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: azure_public_ips_pull
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { azurePublicIpsPull } from 'waldur-js-client';

try {
  const response = await azurePublicIpsPull({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

202 -

Field Type
detail string

409 -

Field Type
detail string

Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state.

1
2
3
4
http \
  POST \
  https://api.example.com/api/azure-public-ips/a1b2c3d4-e5f6-7890-abcd-ef1234567890/unlink/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.azure_public_ips import azure_public_ips_unlink # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = azure_public_ips_unlink.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: azure_public_ips_unlink
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { azurePublicIpsUnlink } from 'waldur-js-client';

try {
  const response = await azurePublicIpsUnlink({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Update

1
2
3
4
5
6
7
8
9
http \
  PUT \
  https://api.example.com/api/azure-public-ips/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-azure-public-ip" \
  service_settings="https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  location="https://api.example.com/api/location/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  resource_group="https://api.example.com/api/resource-group/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.azure_public_ip_request import AzurePublicIPRequest # (1)
from waldur_api_client.api.azure_public_ips import azure_public_ips_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = AzurePublicIPRequest(
    name="my-awesome-azure-public-ip",
    service_settings="https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    location="https://api.example.com/api/location/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    resource_group="https://api.example.com/api/resource-group/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = azure_public_ips_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: AzurePublicIPRequest
  2. API Source: azure_public_ips_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
import { azurePublicIpsUpdate } from 'waldur-js-client';

try {
  const response = await azurePublicIpsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-azure-public-ip",
    "service_settings": "https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "project": "https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "location": "https://api.example.com/api/location/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "resource_group": "https://api.example.com/api/resource-group/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
name string ✓
description string
service_settings string (uri) ✓
project string (uri) ✓
location string (uri) ✓
resource_group string (uri) ✓

200 -

Field Type
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
location string (uri)
resource_group string (uri)
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/azure-public-ips/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_azure_public_ip_request import PatchedAzurePublicIPRequest # (1)
from waldur_api_client.api.azure_public_ips import azure_public_ips_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedAzurePublicIPRequest()
response = azure_public_ips_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedAzurePublicIPRequest
  2. API Source: azure_public_ips_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { azurePublicIpsPartialUpdate } from 'waldur-js-client';

try {
  const response = await azurePublicIpsPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
description string
location string (uri)
resource_group string (uri)

200 -

Field Type
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
location string (uri)
resource_group string (uri)
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/azure-public-ips/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.azure_public_ips import azure_public_ips_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = azure_public_ips_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: azure_public_ips_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { azurePublicIpsDestroy } from 'waldur-js-client';

try {
  const response = await azurePublicIpsDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Other Actions

Mark resource as ERRED

Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.

1
2
3
4
http \
  POST \
  https://api.example.com/api/azure-public-ips/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_erred/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.set_erred_request import SetErredRequest # (1)
from waldur_api_client.api.azure_public_ips import azure_public_ips_set_erred # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = SetErredRequest()
response = azure_public_ips_set_erred.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: SetErredRequest
  2. API Source: azure_public_ips_set_erred
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { azurePublicIpsSetErred } from 'waldur-js-client';

try {
  const response = await azurePublicIpsSetErred({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
error_message string
error_traceback string

200 -

Field Type
detail string

Mark resource as OK

Manually transition the resource to OK state and clear error fields. Staff-only operation.

1
2
3
4
http \
  POST \
  https://api.example.com/api/azure-public-ips/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_ok/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.azure_public_ips import azure_public_ips_set_ok # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = azure_public_ips_set_ok.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: azure_public_ips_set_ok
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { azurePublicIpsSetOk } from 'waldur-js-client';

try {
  const response = await azurePublicIpsSetOk({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
detail string

Azure Resource Groups

Operations Summary

Method Endpoint Description
GET /api/azure-resource-groups/ List Azure Resource Groups
GET /api/azure-resource-groups/{uuid}/ Retrieve

List Azure Resource Groups

1
2
3
4
http \
  GET \
  https://api.example.com/api/azure-resource-groups/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.azure_resource_group_field_enum import AzureResourceGroupFieldEnum # (1)
from waldur_api_client.api.azure_resource_groups import azure_resource_groups_list # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = azure_resource_groups_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: AzureResourceGroupFieldEnum
  2. API Source: azure_resource_groups_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { azureResourceGroupsList } from 'waldur-js-client';

try {
  const response = await azureResourceGroupsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
field array
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
location string (uri)
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/azure-resource-groups/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.azure_resource_group_field_enum import AzureResourceGroupFieldEnum # (1)
from waldur_api_client.api.azure_resource_groups import azure_resource_groups_retrieve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = azure_resource_groups_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. Model Source: AzureResourceGroupFieldEnum
  2. API Source: azure_resource_groups_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { azureResourceGroupsRetrieve } from 'waldur-js-client';

try {
  const response = await azureResourceGroupsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type
field array

200 -

Field Type
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
location string (uri)
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Azure Sizes

Operations Summary

Method Endpoint Description
GET /api/azure-sizes/ List Azure Sizes
GET /api/azure-sizes/{uuid}/ Retrieve

List Azure Sizes

1
2
3
4
http \
  GET \
  https://api.example.com/api/azure-sizes/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.azure_sizes import azure_sizes_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = azure_sizes_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: azure_sizes_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { azureSizesList } from 'waldur-js-client';

try {
  const response = await azureSizesList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
location string (uri)
location_uuid string (uuid)
name string Name
name_exact string Name (exact)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
settings string (uri) Settings URL
settings_uuid string (uuid) Settings UUID
zone integer

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
url string (uri)
uuid string (uuid)
name string
max_data_disk_count integer
memory_in_mb integer
number_of_cores integer
os_disk_size_in_mb integer
resource_disk_size_in_mb integer

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/azure-sizes/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.azure_sizes import azure_sizes_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = azure_sizes_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: azure_sizes_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { azureSizesRetrieve } from 'waldur-js-client';

try {
  const response = await azureSizesRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
url string (uri)
uuid string (uuid)
name string
max_data_disk_count integer
memory_in_mb integer
number_of_cores integer
os_disk_size_in_mb integer
resource_disk_size_in_mb integer

Azure Sql Databases

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/azure-sql-databases/ List Azure Sql Databases
GET /api/azure-sql-databases/{uuid}/ Retrieve
POST /api/azure-sql-databases/ Create
POST /api/azure-sql-databases/{uuid}/pull/ Synchronize resource state
POST /api/azure-sql-databases/{uuid}/unlink/ Unlink resource
PUT /api/azure-sql-databases/{uuid}/ Update
PATCH /api/azure-sql-databases/{uuid}/ Partial Update
DELETE /api/azure-sql-databases/{uuid}/ Delete
Other Actions
POST /api/azure-sql-databases/{uuid}/set_erred/ Mark resource as ERRED
POST /api/azure-sql-databases/{uuid}/set_ok/ Mark resource as OK

Core CRUD

List Azure Sql Databases

1
2
3
4
http \
  GET \
  https://api.example.com/api/azure-sql-databases/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.azure_sql_database_field_enum import AzureSqlDatabaseFieldEnum # (1)
from waldur_api_client.models.core_states import CoreStates # (2)
from waldur_api_client.api.azure_sql_databases import azure_sql_databases_list # (3)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = azure_sql_databases_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: AzureSqlDatabaseFieldEnum
  2. Model Source: CoreStates
  3. API Source: azure_sql_databases_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { azureSqlDatabasesList } from 'waldur-js-client';

try {
  const response = await azureSqlDatabasesList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
backend_id string Backend ID
can_manage boolean Can manage
customer string (uuid) Customer UUID
customer_abbreviation string Customer abbreviation
customer_name string Customer name
customer_native_name string Customer native name
customer_uuid string (uuid) Customer UUID
description string Description
external_ip string External IP
field array
name string Name
name_exact string Name (exact)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
project string (uuid) Project UUID
project_name string Project name
project_uuid string (uuid) Project UUID
resource_group string (uri)
resource_group_uuid string (uuid)
server string (uri)
server_uuid string (uuid)
service_settings_name string Service settings name
service_settings_uuid string (uuid) Service settings UUID
state array State
uuid string (uuid) UUID

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
server string (uri)
charset string
collation string
resource_group_name string
location_name string
server_name string
server_uuid string (uuid)
server_marketplace_uuid string (uuid)
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/azure-sql-databases/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.azure_sql_database_field_enum import AzureSqlDatabaseFieldEnum # (1)
from waldur_api_client.api.azure_sql_databases import azure_sql_databases_retrieve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = azure_sql_databases_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. Model Source: AzureSqlDatabaseFieldEnum
  2. API Source: azure_sql_databases_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { azureSqlDatabasesRetrieve } from 'waldur-js-client';

try {
  const response = await azureSqlDatabasesRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type
field array

200 -

Field Type
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
server string (uri)
charset string
collation string
resource_group_name string
location_name string
server_name string
server_uuid string (uuid)
server_marketplace_uuid string (uuid)
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Create

1
2
3
4
5
6
7
8
http \
  POST \
  https://api.example.com/api/azure-sql-databases/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-azure-sql-database" \
  service_settings="https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  server="https://api.example.com/api/server/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.azure_sql_database_request import AzureSqlDatabaseRequest # (1)
from waldur_api_client.api.azure_sql_databases import azure_sql_databases_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = AzureSqlDatabaseRequest(
    name="my-awesome-azure-sql-database",
    service_settings="https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    server="https://api.example.com/api/server/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = azure_sql_databases_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: AzureSqlDatabaseRequest
  2. API Source: azure_sql_databases_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { azureSqlDatabasesCreate } from 'waldur-js-client';

try {
  const response = await azureSqlDatabasesCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "name": "my-awesome-azure-sql-database",
    "service_settings": "https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "project": "https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "server": "https://api.example.com/api/server/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required
name string ✓
description string
service_settings string (uri) ✓
project string (uri) ✓
server string (uri) ✓
charset string
collation string

201 -

Field Type
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
server string (uri)
charset string
collation string
resource_group_name string
location_name string
server_name string
server_uuid string (uuid)
server_marketplace_uuid string (uuid)
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Synchronize resource state

Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.

1
2
3
4
http \
  POST \
  https://api.example.com/api/azure-sql-databases/a1b2c3d4-e5f6-7890-abcd-ef1234567890/pull/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.azure_sql_databases import azure_sql_databases_pull # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = azure_sql_databases_pull.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: azure_sql_databases_pull
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { azureSqlDatabasesPull } from 'waldur-js-client';

try {
  const response = await azureSqlDatabasesPull({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

202 -

Field Type
detail string

409 -

Field Type
detail string

Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state.

1
2
3
4
http \
  POST \
  https://api.example.com/api/azure-sql-databases/a1b2c3d4-e5f6-7890-abcd-ef1234567890/unlink/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.azure_sql_databases import azure_sql_databases_unlink # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = azure_sql_databases_unlink.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: azure_sql_databases_unlink
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { azureSqlDatabasesUnlink } from 'waldur-js-client';

try {
  const response = await azureSqlDatabasesUnlink({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Update

1
2
3
4
5
6
7
8
http \
  PUT \
  https://api.example.com/api/azure-sql-databases/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-azure-sql-database" \
  service_settings="https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  server="https://api.example.com/api/server/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.azure_sql_database_request import AzureSqlDatabaseRequest # (1)
from waldur_api_client.api.azure_sql_databases import azure_sql_databases_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = AzureSqlDatabaseRequest(
    name="my-awesome-azure-sql-database",
    service_settings="https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    server="https://api.example.com/api/server/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = azure_sql_databases_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: AzureSqlDatabaseRequest
  2. API Source: azure_sql_databases_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
import { azureSqlDatabasesUpdate } from 'waldur-js-client';

try {
  const response = await azureSqlDatabasesUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-azure-sql-database",
    "service_settings": "https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "project": "https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "server": "https://api.example.com/api/server/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
name string ✓
description string
service_settings string (uri) ✓
project string (uri) ✓
server string (uri) ✓
charset string
collation string

200 -

Field Type
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
server string (uri)
charset string
collation string
resource_group_name string
location_name string
server_name string
server_uuid string (uuid)
server_marketplace_uuid string (uuid)
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/azure-sql-databases/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_azure_sql_database_request import PatchedAzureSqlDatabaseRequest # (1)
from waldur_api_client.api.azure_sql_databases import azure_sql_databases_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedAzureSqlDatabaseRequest()
response = azure_sql_databases_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedAzureSqlDatabaseRequest
  2. API Source: azure_sql_databases_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { azureSqlDatabasesPartialUpdate } from 'waldur-js-client';

try {
  const response = await azureSqlDatabasesPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
description string
server string (uri)
charset string
collation string

200 -

Field Type
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
server string (uri)
charset string
collation string
resource_group_name string
location_name string
server_name string
server_uuid string (uuid)
server_marketplace_uuid string (uuid)
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/azure-sql-databases/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.azure_sql_databases import azure_sql_databases_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = azure_sql_databases_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: azure_sql_databases_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { azureSqlDatabasesDestroy } from 'waldur-js-client';

try {
  const response = await azureSqlDatabasesDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Other Actions

Mark resource as ERRED

Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.

1
2
3
4
http \
  POST \
  https://api.example.com/api/azure-sql-databases/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_erred/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.set_erred_request import SetErredRequest # (1)
from waldur_api_client.api.azure_sql_databases import azure_sql_databases_set_erred # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = SetErredRequest()
response = azure_sql_databases_set_erred.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: SetErredRequest
  2. API Source: azure_sql_databases_set_erred
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { azureSqlDatabasesSetErred } from 'waldur-js-client';

try {
  const response = await azureSqlDatabasesSetErred({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
error_message string
error_traceback string

200 -

Field Type
detail string

Mark resource as OK

Manually transition the resource to OK state and clear error fields. Staff-only operation.

1
2
3
4
http \
  POST \
  https://api.example.com/api/azure-sql-databases/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_ok/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.azure_sql_databases import azure_sql_databases_set_ok # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = azure_sql_databases_set_ok.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: azure_sql_databases_set_ok
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { azureSqlDatabasesSetOk } from 'waldur-js-client';

try {
  const response = await azureSqlDatabasesSetOk({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
detail string

Azure Sql Servers

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/azure-sql-servers/ List Azure Sql Servers
GET /api/azure-sql-servers/{uuid}/ Retrieve
POST /api/azure-sql-servers/ Create
POST /api/azure-sql-servers/{uuid}/create_database/ Create database
POST /api/azure-sql-servers/{uuid}/pull/ Synchronize resource state
POST /api/azure-sql-servers/{uuid}/unlink/ Unlink resource
PUT /api/azure-sql-servers/{uuid}/ Update
PATCH /api/azure-sql-servers/{uuid}/ Partial Update
DELETE /api/azure-sql-servers/{uuid}/ Delete
Other Actions
POST /api/azure-sql-servers/{uuid}/set_erred/ Mark resource as ERRED
POST /api/azure-sql-servers/{uuid}/set_ok/ Mark resource as OK

Core CRUD

List Azure Sql Servers

1
2
3
4
http \
  GET \
  https://api.example.com/api/azure-sql-servers/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.azure_sql_server_field_enum import AzureSqlServerFieldEnum # (1)
from waldur_api_client.models.core_states import CoreStates # (2)
from waldur_api_client.api.azure_sql_servers import azure_sql_servers_list # (3)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = azure_sql_servers_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: AzureSqlServerFieldEnum
  2. Model Source: CoreStates
  3. API Source: azure_sql_servers_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { azureSqlServersList } from 'waldur-js-client';

try {
  const response = await azureSqlServersList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
backend_id string Backend ID
can_manage boolean Can manage
customer string (uuid) Customer UUID
customer_abbreviation string Customer abbreviation
customer_name string Customer name
customer_native_name string Customer native name
customer_uuid string (uuid) Customer UUID
description string Description
external_ip string External IP
field array
name string Name
name_exact string Name (exact)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
project string (uuid) Project UUID
project_name string Project name
project_uuid string (uuid) Project UUID
resource_group string (uri)
resource_group_uuid string (uuid)
service_settings_name string Service settings name
service_settings_uuid string (uuid) Service settings UUID
state array State
uuid string (uuid) UUID

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
resource_group string (uri)
username string
password string
storage_mb integer
fqdn string
resource_group_name string
location_name string
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/azure-sql-servers/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.azure_sql_server_field_enum import AzureSqlServerFieldEnum # (1)
from waldur_api_client.api.azure_sql_servers import azure_sql_servers_retrieve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = azure_sql_servers_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. Model Source: AzureSqlServerFieldEnum
  2. API Source: azure_sql_servers_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { azureSqlServersRetrieve } from 'waldur-js-client';

try {
  const response = await azureSqlServersRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type
field array

200 -

Field Type
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
resource_group string (uri)
username string
password string
storage_mb integer
fqdn string
resource_group_name string
location_name string
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Create

1
2
3
4
5
6
7
8
http \
  POST \
  https://api.example.com/api/azure-sql-servers/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-azure-sql-server" \
  service_settings="https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  location="https://api.example.com/api/location/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.azure_sql_server_request import AzureSqlServerRequest # (1)
from waldur_api_client.api.azure_sql_servers import azure_sql_servers_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = AzureSqlServerRequest(
    name="my-awesome-azure-sql-server",
    service_settings="https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    location="https://api.example.com/api/location/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = azure_sql_servers_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: AzureSqlServerRequest
  2. API Source: azure_sql_servers_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { azureSqlServersCreate } from 'waldur-js-client';

try {
  const response = await azureSqlServersCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "name": "my-awesome-azure-sql-server",
    "service_settings": "https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "project": "https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "location": "https://api.example.com/api/location/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required
name string ✓
description string
service_settings string (uri) ✓
project string (uri) ✓
location string (uri) ✓
storage_mb integer

201 -

Field Type
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
resource_group string (uri)
username string
password string
storage_mb integer
fqdn string
resource_group_name string
location_name string
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Create database

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/azure-sql-servers/a1b2c3d4-e5f6-7890-abcd-ef1234567890/create_database/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-azure-sql-server"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.azure_sql_database_create_request import AzureSqlDatabaseCreateRequest # (1)
from waldur_api_client.api.azure_sql_servers import azure_sql_servers_create_database # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = AzureSqlDatabaseCreateRequest(
    name="my-awesome-azure-sql-server"
)
response = azure_sql_servers_create_database.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: AzureSqlDatabaseCreateRequest
  2. API Source: azure_sql_servers_create_database
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { azureSqlServersCreateDatabase } from 'waldur-js-client';

try {
  const response = await azureSqlServersCreateDatabase({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-azure-sql-server"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
name string ✓
description string

200 -

Field Type
name string
description string

Synchronize resource state

Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.

1
2
3
4
http \
  POST \
  https://api.example.com/api/azure-sql-servers/a1b2c3d4-e5f6-7890-abcd-ef1234567890/pull/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.azure_sql_servers import azure_sql_servers_pull # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = azure_sql_servers_pull.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: azure_sql_servers_pull
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { azureSqlServersPull } from 'waldur-js-client';

try {
  const response = await azureSqlServersPull({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

202 -

Field Type
detail string

409 -

Field Type
detail string

Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state.

1
2
3
4
http \
  POST \
  https://api.example.com/api/azure-sql-servers/a1b2c3d4-e5f6-7890-abcd-ef1234567890/unlink/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.azure_sql_servers import azure_sql_servers_unlink # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = azure_sql_servers_unlink.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: azure_sql_servers_unlink
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { azureSqlServersUnlink } from 'waldur-js-client';

try {
  const response = await azureSqlServersUnlink({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Update

1
2
3
4
5
6
7
8
http \
  PUT \
  https://api.example.com/api/azure-sql-servers/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-azure-sql-server" \
  service_settings="https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  location="https://api.example.com/api/location/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.azure_sql_server_request import AzureSqlServerRequest # (1)
from waldur_api_client.api.azure_sql_servers import azure_sql_servers_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = AzureSqlServerRequest(
    name="my-awesome-azure-sql-server",
    service_settings="https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    location="https://api.example.com/api/location/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = azure_sql_servers_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: AzureSqlServerRequest
  2. API Source: azure_sql_servers_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
import { azureSqlServersUpdate } from 'waldur-js-client';

try {
  const response = await azureSqlServersUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-azure-sql-server",
    "service_settings": "https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "project": "https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "location": "https://api.example.com/api/location/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
name string ✓
description string
service_settings string (uri) ✓
project string (uri) ✓
location string (uri) ✓
storage_mb integer

200 -

Field Type
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
resource_group string (uri)
username string
password string
storage_mb integer
fqdn string
resource_group_name string
location_name string
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/azure-sql-servers/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_azure_sql_server_request import PatchedAzureSqlServerRequest # (1)
from waldur_api_client.api.azure_sql_servers import azure_sql_servers_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedAzureSqlServerRequest()
response = azure_sql_servers_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedAzureSqlServerRequest
  2. API Source: azure_sql_servers_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { azureSqlServersPartialUpdate } from 'waldur-js-client';

try {
  const response = await azureSqlServersPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
description string
location string (uri)
storage_mb integer

200 -

Field Type
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
resource_group string (uri)
username string
password string
storage_mb integer
fqdn string
resource_group_name string
location_name string
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/azure-sql-servers/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.azure_sql_servers import azure_sql_servers_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = azure_sql_servers_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: azure_sql_servers_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { azureSqlServersDestroy } from 'waldur-js-client';

try {
  const response = await azureSqlServersDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Other Actions

Mark resource as ERRED

Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.

1
2
3
4
http \
  POST \
  https://api.example.com/api/azure-sql-servers/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_erred/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.set_erred_request import SetErredRequest # (1)
from waldur_api_client.api.azure_sql_servers import azure_sql_servers_set_erred # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = SetErredRequest()
response = azure_sql_servers_set_erred.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: SetErredRequest
  2. API Source: azure_sql_servers_set_erred
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { azureSqlServersSetErred } from 'waldur-js-client';

try {
  const response = await azureSqlServersSetErred({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
error_message string
error_traceback string

200 -

Field Type
detail string

Mark resource as OK

Manually transition the resource to OK state and clear error fields. Staff-only operation.

1
2
3
4
http \
  POST \
  https://api.example.com/api/azure-sql-servers/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_ok/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.azure_sql_servers import azure_sql_servers_set_ok # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = azure_sql_servers_set_ok.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: azure_sql_servers_set_ok
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { azureSqlServersSetOk } from 'waldur-js-client';

try {
  const response = await azureSqlServersSetOk({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
detail string

Azure Virtualmachines

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/azure-virtualmachines/ List Azure Virtualmachines
GET /api/azure-virtualmachines/{uuid}/ Retrieve
POST /api/azure-virtualmachines/ Create
POST /api/azure-virtualmachines/{uuid}/pull/ Synchronize resource state
POST /api/azure-virtualmachines/{uuid}/unlink/ Unlink resource
PUT /api/azure-virtualmachines/{uuid}/ Update
PATCH /api/azure-virtualmachines/{uuid}/ Partial Update
DELETE /api/azure-virtualmachines/{uuid}/ Delete
Other Actions
POST /api/azure-virtualmachines/{uuid}/restart/ Restart
POST /api/azure-virtualmachines/{uuid}/set_erred/ Mark resource as ERRED
POST /api/azure-virtualmachines/{uuid}/set_ok/ Mark resource as OK
POST /api/azure-virtualmachines/{uuid}/start/ Start
POST /api/azure-virtualmachines/{uuid}/stop/ Stop

Core CRUD

List Azure Virtualmachines

1
2
3
4
http \
  GET \
  https://api.example.com/api/azure-virtualmachines/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.azure_virtual_machine_field_enum import AzureVirtualMachineFieldEnum # (1)
from waldur_api_client.models.core_states import CoreStates # (2)
from waldur_api_client.api.azure_virtualmachines import azure_virtualmachines_list # (3)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = azure_virtualmachines_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: AzureVirtualMachineFieldEnum
  2. Model Source: CoreStates
  3. API Source: azure_virtualmachines_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { azureVirtualmachinesList } from 'waldur-js-client';

try {
  const response = await azureVirtualmachinesList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
backend_id string Backend ID
can_manage boolean Can manage
customer string (uuid) Customer UUID
customer_abbreviation string Customer abbreviation
customer_name string Customer name
customer_native_name string Customer native name
customer_uuid string (uuid) Customer UUID
description string Description
external_ip string External IP
field array
name string Name
name_exact string Name (exact)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
project string (uuid) Project UUID
project_name string Project name
project_uuid string (uuid) Project UUID
resource_group string (uri)
resource_group_uuid string (uuid)
service_settings_name string Service settings name
service_settings_uuid string (uuid) Service settings UUID
state array State
uuid string (uuid) UUID

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
start_time string (date-time)
cores integer Number of cores in a VM
ram integer Memory size in MiB
disk integer Disk size in MiB
min_ram integer Minimum memory size in MiB
min_disk integer Minimum disk size in MiB
user_data string Additional data that will be added to instance on provisioning
external_ips array of string (ipv4)s
internal_ips array of string (ipv4)s
latitude number (double)
longitude number (double)
key_name string
key_fingerprint string
image_name string
image string (uri)
size string (uri)
runtime_state string
resource_group string (uri)
username string
password string
resource_group_name string
location_name string
size_name string
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/azure-virtualmachines/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.azure_virtual_machine_field_enum import AzureVirtualMachineFieldEnum # (1)
from waldur_api_client.api.azure_virtualmachines import azure_virtualmachines_retrieve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = azure_virtualmachines_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. Model Source: AzureVirtualMachineFieldEnum
  2. API Source: azure_virtualmachines_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { azureVirtualmachinesRetrieve } from 'waldur-js-client';

try {
  const response = await azureVirtualmachinesRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type
field array

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
start_time string (date-time)
cores integer Number of cores in a VM
ram integer Memory size in MiB
disk integer Disk size in MiB
min_ram integer Minimum memory size in MiB
min_disk integer Minimum disk size in MiB
user_data string Additional data that will be added to instance on provisioning
external_ips array of string (ipv4)s
internal_ips array of string (ipv4)s
latitude number (double)
longitude number (double)
key_name string
key_fingerprint string
image_name string
image string (uri)
size string (uri)
runtime_state string
resource_group string (uri)
username string
password string
resource_group_name string
location_name string
size_name string
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Create

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
http \
  POST \
  https://api.example.com/api/azure-virtualmachines/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-azure-virtualmachine" \
  service_settings="https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  image="https://api.example.com/api/image/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  size=100 \
  location="https://api.example.com/api/location/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.azure_virtual_machine_request import AzureVirtualMachineRequest # (1)
from waldur_api_client.api.azure_virtualmachines import azure_virtualmachines_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = AzureVirtualMachineRequest(
    name="my-awesome-azure-virtualmachine",
    service_settings="https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    image="https://api.example.com/api/image/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    size=100,
    location="https://api.example.com/api/location/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = azure_virtualmachines_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: AzureVirtualMachineRequest
  2. API Source: azure_virtualmachines_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
import { azureVirtualmachinesCreate } from 'waldur-js-client';

try {
  const response = await azureVirtualmachinesCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "name": "my-awesome-azure-virtualmachine",
    "service_settings": "https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "project": "https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "image": "https://api.example.com/api/image/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "size": 100,
    "location": "https://api.example.com/api/location/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
name string ✓
description string
service_settings string (uri) ✓
project string (uri) ✓
ssh_public_key string (uri)
Constraints: write-only
user_data string Additional data that will be added to instance on provisioning
image string (uri) ✓
size string (uri) ✓
location string (uri) ✓
Constraints: write-only

201 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
start_time string (date-time)
cores integer Number of cores in a VM
ram integer Memory size in MiB
disk integer Disk size in MiB
min_ram integer Minimum memory size in MiB
min_disk integer Minimum disk size in MiB
user_data string Additional data that will be added to instance on provisioning
external_ips array of string (ipv4)s
internal_ips array of string (ipv4)s
latitude number (double)
longitude number (double)
key_name string
key_fingerprint string
image_name string
image string (uri)
size string (uri)
runtime_state string
resource_group string (uri)
username string
password string
resource_group_name string
location_name string
size_name string
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Synchronize resource state

Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.

1
2
3
4
http \
  POST \
  https://api.example.com/api/azure-virtualmachines/a1b2c3d4-e5f6-7890-abcd-ef1234567890/pull/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.azure_virtualmachines import azure_virtualmachines_pull # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = azure_virtualmachines_pull.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: azure_virtualmachines_pull
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { azureVirtualmachinesPull } from 'waldur-js-client';

try {
  const response = await azureVirtualmachinesPull({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

202 -

Field Type
detail string

409 -

Field Type
detail string

Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state.

1
2
3
4
http \
  POST \
  https://api.example.com/api/azure-virtualmachines/a1b2c3d4-e5f6-7890-abcd-ef1234567890/unlink/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.azure_virtualmachines import azure_virtualmachines_unlink # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = azure_virtualmachines_unlink.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: azure_virtualmachines_unlink
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { azureVirtualmachinesUnlink } from 'waldur-js-client';

try {
  const response = await azureVirtualmachinesUnlink({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Update

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
http \
  PUT \
  https://api.example.com/api/azure-virtualmachines/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-azure-virtualmachine" \
  service_settings="https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  image="https://api.example.com/api/image/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  size=100 \
  location="https://api.example.com/api/location/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.azure_virtual_machine_request import AzureVirtualMachineRequest # (1)
from waldur_api_client.api.azure_virtualmachines import azure_virtualmachines_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = AzureVirtualMachineRequest(
    name="my-awesome-azure-virtualmachine",
    service_settings="https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    image="https://api.example.com/api/image/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    size=100,
    location="https://api.example.com/api/location/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = azure_virtualmachines_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: AzureVirtualMachineRequest
  2. API Source: azure_virtualmachines_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
import { azureVirtualmachinesUpdate } from 'waldur-js-client';

try {
  const response = await azureVirtualmachinesUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-azure-virtualmachine",
    "service_settings": "https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "project": "https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "image": "https://api.example.com/api/image/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "size": 100,
    "location": "https://api.example.com/api/location/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
name string ✓
description string
service_settings string (uri) ✓
project string (uri) ✓
ssh_public_key string (uri)
Constraints: write-only
user_data string Additional data that will be added to instance on provisioning
image string (uri) ✓
size string (uri) ✓
location string (uri) ✓
Constraints: write-only

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
start_time string (date-time)
cores integer Number of cores in a VM
ram integer Memory size in MiB
disk integer Disk size in MiB
min_ram integer Minimum memory size in MiB
min_disk integer Minimum disk size in MiB
user_data string Additional data that will be added to instance on provisioning
external_ips array of string (ipv4)s
internal_ips array of string (ipv4)s
latitude number (double)
longitude number (double)
key_name string
key_fingerprint string
image_name string
image string (uri)
size string (uri)
runtime_state string
resource_group string (uri)
username string
password string
resource_group_name string
location_name string
size_name string
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/azure-virtualmachines/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_azure_virtual_machine_request import PatchedAzureVirtualMachineRequest # (1)
from waldur_api_client.api.azure_virtualmachines import azure_virtualmachines_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedAzureVirtualMachineRequest()
response = azure_virtualmachines_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedAzureVirtualMachineRequest
  2. API Source: azure_virtualmachines_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { azureVirtualmachinesPartialUpdate } from 'waldur-js-client';

try {
  const response = await azureVirtualmachinesPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
description string
location string (uri)

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
start_time string (date-time)
cores integer Number of cores in a VM
ram integer Memory size in MiB
disk integer Disk size in MiB
min_ram integer Minimum memory size in MiB
min_disk integer Minimum disk size in MiB
user_data string Additional data that will be added to instance on provisioning
external_ips array of string (ipv4)s
internal_ips array of string (ipv4)s
latitude number (double)
longitude number (double)
key_name string
key_fingerprint string
image_name string
image string (uri)
size string (uri)
runtime_state string
resource_group string (uri)
username string
password string
resource_group_name string
location_name string
size_name string
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/azure-virtualmachines/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.azure_virtualmachines import azure_virtualmachines_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = azure_virtualmachines_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: azure_virtualmachines_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { azureVirtualmachinesDestroy } from 'waldur-js-client';

try {
  const response = await azureVirtualmachinesDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Other Actions

Restart

1
2
3
4
http \
  POST \
  https://api.example.com/api/azure-virtualmachines/a1b2c3d4-e5f6-7890-abcd-ef1234567890/restart/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.azure_virtualmachines import azure_virtualmachines_restart # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = azure_virtualmachines_restart.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: azure_virtualmachines_restart
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { azureVirtualmachinesRestart } from 'waldur-js-client';

try {
  const response = await azureVirtualmachinesRestart({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 - No response body

Mark resource as ERRED

Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.

1
2
3
4
http \
  POST \
  https://api.example.com/api/azure-virtualmachines/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_erred/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.set_erred_request import SetErredRequest # (1)
from waldur_api_client.api.azure_virtualmachines import azure_virtualmachines_set_erred # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = SetErredRequest()
response = azure_virtualmachines_set_erred.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: SetErredRequest
  2. API Source: azure_virtualmachines_set_erred
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { azureVirtualmachinesSetErred } from 'waldur-js-client';

try {
  const response = await azureVirtualmachinesSetErred({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
error_message string
error_traceback string

200 -

Field Type
detail string

Mark resource as OK

Manually transition the resource to OK state and clear error fields. Staff-only operation.

1
2
3
4
http \
  POST \
  https://api.example.com/api/azure-virtualmachines/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_ok/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.azure_virtualmachines import azure_virtualmachines_set_ok # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = azure_virtualmachines_set_ok.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: azure_virtualmachines_set_ok
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { azureVirtualmachinesSetOk } from 'waldur-js-client';

try {
  const response = await azureVirtualmachinesSetOk({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
detail string

Start

1
2
3
4
http \
  POST \
  https://api.example.com/api/azure-virtualmachines/a1b2c3d4-e5f6-7890-abcd-ef1234567890/start/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.azure_virtualmachines import azure_virtualmachines_start # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = azure_virtualmachines_start.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: azure_virtualmachines_start
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { azureVirtualmachinesStart } from 'waldur-js-client';

try {
  const response = await azureVirtualmachinesStart({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 - No response body

Stop

1
2
3
4
http \
  POST \
  https://api.example.com/api/azure-virtualmachines/a1b2c3d4-e5f6-7890-abcd-ef1234567890/stop/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.azure_virtualmachines import azure_virtualmachines_stop # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = azure_virtualmachines_stop.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: azure_virtualmachines_stop
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { azureVirtualmachinesStop } from 'waldur-js-client';

try {
  const response = await azureVirtualmachinesStop({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 - No response body

Digitalocean

Digitalocean Droplets

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/digitalocean-droplets/ List Digitalocean Droplets
GET /api/digitalocean-droplets/{uuid}/ Retrieve
POST /api/digitalocean-droplets/ Create
POST /api/digitalocean-droplets/{uuid}/pull/ Synchronize resource state
POST /api/digitalocean-droplets/{uuid}/unlink/ Unlink resource
PUT /api/digitalocean-droplets/{uuid}/ Update
PATCH /api/digitalocean-droplets/{uuid}/ Partial Update
DELETE /api/digitalocean-droplets/{uuid}/ Delete
Other Actions
POST /api/digitalocean-droplets/{uuid}/resize/ Resize
POST /api/digitalocean-droplets/{uuid}/restart/ Restart
POST /api/digitalocean-droplets/{uuid}/set_erred/ Mark resource as ERRED
POST /api/digitalocean-droplets/{uuid}/set_ok/ Mark resource as OK
POST /api/digitalocean-droplets/{uuid}/start/ Start
POST /api/digitalocean-droplets/{uuid}/stop/ Stop

Core CRUD

List Digitalocean Droplets

1
2
3
4
http \
  GET \
  https://api.example.com/api/digitalocean-droplets/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.core_states import CoreStates # (1)
from waldur_api_client.models.digital_ocean_droplet_field_enum import DigitalOceanDropletFieldEnum # (2)
from waldur_api_client.api.digitalocean_droplets import digitalocean_droplets_list # (3)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = digitalocean_droplets_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: CoreStates
  2. Model Source: DigitalOceanDropletFieldEnum
  3. API Source: digitalocean_droplets_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { digitaloceanDropletsList } from 'waldur-js-client';

try {
  const response = await digitaloceanDropletsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
backend_id string Backend ID
can_manage boolean Can manage
customer string (uuid) Customer UUID
customer_abbreviation string Customer abbreviation
customer_name string Customer name
customer_native_name string Customer native name
customer_uuid string (uuid) Customer UUID
description string Description
external_ip string
field array
name string Name
name_exact string Name (exact)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
project string (uuid) Project UUID
project_name string Project name
project_uuid string (uuid) Project UUID
service_settings_name string Service settings name
service_settings_uuid string (uuid) Service settings UUID
state array State
uuid string (uuid) UUID

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
start_time string (date-time)
cores integer Number of cores in a VM
ram integer Memory size in MiB
disk integer Disk size in MiB
min_ram integer Minimum memory size in MiB
min_disk integer Minimum disk size in MiB
user_data string Additional data that will be added to instance on provisioning
external_ips array of string (ipv4)s
internal_ips array of string (ipv4)s
latitude number (double)
longitude number (double)
key_name string
key_fingerprint string
image_name string
runtime_state string
region_name string
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/digitalocean-droplets/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.digital_ocean_droplet_field_enum import DigitalOceanDropletFieldEnum # (1)
from waldur_api_client.api.digitalocean_droplets import digitalocean_droplets_retrieve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = digitalocean_droplets_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. Model Source: DigitalOceanDropletFieldEnum
  2. API Source: digitalocean_droplets_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { digitaloceanDropletsRetrieve } from 'waldur-js-client';

try {
  const response = await digitaloceanDropletsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type
field array

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
start_time string (date-time)
cores integer Number of cores in a VM
ram integer Memory size in MiB
disk integer Disk size in MiB
min_ram integer Minimum memory size in MiB
min_disk integer Minimum disk size in MiB
user_data string Additional data that will be added to instance on provisioning
external_ips array of string (ipv4)s
internal_ips array of string (ipv4)s
latitude number (double)
longitude number (double)
key_name string
key_fingerprint string
image_name string
runtime_state string
region_name string
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Create

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
http \
  POST \
  https://api.example.com/api/digitalocean-droplets/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-digitalocean-droplet" \
  service_settings="https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  region="https://api.example.com/api/region/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  image="https://api.example.com/api/image/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  size=100

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.digital_ocean_droplet_request import DigitalOceanDropletRequest # (1)
from waldur_api_client.api.digitalocean_droplets import digitalocean_droplets_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = DigitalOceanDropletRequest(
    name="my-awesome-digitalocean-droplet",
    service_settings="https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    region="https://api.example.com/api/region/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    image="https://api.example.com/api/image/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    size=100
)
response = digitalocean_droplets_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: DigitalOceanDropletRequest
  2. API Source: digitalocean_droplets_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
import { digitaloceanDropletsCreate } from 'waldur-js-client';

try {
  const response = await digitaloceanDropletsCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "name": "my-awesome-digitalocean-droplet",
    "service_settings": "https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "project": "https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "region": "https://api.example.com/api/region/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "image": "https://api.example.com/api/image/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "size": 100
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
name string ✓
description string
service_settings string (uri) ✓
project string (uri) ✓
ssh_public_key string (uri)
Constraints: write-only
user_data string Additional data that will be added to instance on provisioning
region string (uri) ✓
Constraints: write-only
image string (uri) ✓
Constraints: write-only
size string (uri) ✓
Constraints: write-only

201 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
start_time string (date-time)
cores integer Number of cores in a VM
ram integer Memory size in MiB
disk integer Disk size in MiB
min_ram integer Minimum memory size in MiB
min_disk integer Minimum disk size in MiB
user_data string Additional data that will be added to instance on provisioning
external_ips array of string (ipv4)s
internal_ips array of string (ipv4)s
latitude number (double)
longitude number (double)
key_name string
key_fingerprint string
image_name string
runtime_state string
region_name string
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Synchronize resource state

Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.

1
2
3
4
http \
  POST \
  https://api.example.com/api/digitalocean-droplets/a1b2c3d4-e5f6-7890-abcd-ef1234567890/pull/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.digitalocean_droplets import digitalocean_droplets_pull # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = digitalocean_droplets_pull.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: digitalocean_droplets_pull
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { digitaloceanDropletsPull } from 'waldur-js-client';

try {
  const response = await digitaloceanDropletsPull({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

202 -

Field Type
detail string

409 -

Field Type
detail string

Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state.

1
2
3
4
http \
  POST \
  https://api.example.com/api/digitalocean-droplets/a1b2c3d4-e5f6-7890-abcd-ef1234567890/unlink/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.digitalocean_droplets import digitalocean_droplets_unlink # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = digitalocean_droplets_unlink.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: digitalocean_droplets_unlink
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { digitaloceanDropletsUnlink } from 'waldur-js-client';

try {
  const response = await digitaloceanDropletsUnlink({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Update

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
http \
  PUT \
  https://api.example.com/api/digitalocean-droplets/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-digitalocean-droplet" \
  service_settings="https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  region="https://api.example.com/api/region/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  image="https://api.example.com/api/image/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  size=100

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.digital_ocean_droplet_request import DigitalOceanDropletRequest # (1)
from waldur_api_client.api.digitalocean_droplets import digitalocean_droplets_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = DigitalOceanDropletRequest(
    name="my-awesome-digitalocean-droplet",
    service_settings="https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    region="https://api.example.com/api/region/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    image="https://api.example.com/api/image/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    size=100
)
response = digitalocean_droplets_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: DigitalOceanDropletRequest
  2. API Source: digitalocean_droplets_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
import { digitaloceanDropletsUpdate } from 'waldur-js-client';

try {
  const response = await digitaloceanDropletsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-digitalocean-droplet",
    "service_settings": "https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "project": "https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "region": "https://api.example.com/api/region/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "image": "https://api.example.com/api/image/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "size": 100
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
name string ✓
description string
service_settings string (uri) ✓
project string (uri) ✓
ssh_public_key string (uri)
Constraints: write-only
user_data string Additional data that will be added to instance on provisioning
region string (uri) ✓
Constraints: write-only
image string (uri) ✓
Constraints: write-only
size string (uri) ✓
Constraints: write-only

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
start_time string (date-time)
cores integer Number of cores in a VM
ram integer Memory size in MiB
disk integer Disk size in MiB
min_ram integer Minimum memory size in MiB
min_disk integer Minimum disk size in MiB
user_data string Additional data that will be added to instance on provisioning
external_ips array of string (ipv4)s
internal_ips array of string (ipv4)s
latitude number (double)
longitude number (double)
key_name string
key_fingerprint string
image_name string
runtime_state string
region_name string
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/digitalocean-droplets/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_digital_ocean_droplet_request import PatchedDigitalOceanDropletRequest # (1)
from waldur_api_client.api.digitalocean_droplets import digitalocean_droplets_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedDigitalOceanDropletRequest()
response = digitalocean_droplets_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedDigitalOceanDropletRequest
  2. API Source: digitalocean_droplets_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { digitaloceanDropletsPartialUpdate } from 'waldur-js-client';

try {
  const response = await digitaloceanDropletsPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
name string
description string

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
start_time string (date-time)
cores integer Number of cores in a VM
ram integer Memory size in MiB
disk integer Disk size in MiB
min_ram integer Minimum memory size in MiB
min_disk integer Minimum disk size in MiB
user_data string Additional data that will be added to instance on provisioning
external_ips array of string (ipv4)s
internal_ips array of string (ipv4)s
latitude number (double)
longitude number (double)
key_name string
key_fingerprint string
image_name string
runtime_state string
region_name string
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/digitalocean-droplets/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.digitalocean_droplets import digitalocean_droplets_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = digitalocean_droplets_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: digitalocean_droplets_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { digitaloceanDropletsDestroy } from 'waldur-js-client';

try {
  const response = await digitaloceanDropletsDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Other Actions

Resize

To resize droplet, submit a POST request to the instance URL, specifying URI of a target size.

Pass {'disk': true} along with target size in order to perform permanent resizing, which allows you to resize your disk space as well as CPU and RAM. After increasing the disk size, you will not be able to decrease it.

Pass {'disk': false} along with target size in order to perform flexible resizing, which only upgrades your CPU and RAM. This option is reversible.

Note that instance must be OFFLINE.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/digitalocean-droplets/a1b2c3d4-e5f6-7890-abcd-ef1234567890/resize/ \
  Authorization:"Token YOUR_API_TOKEN" \
  size=100 \
  disk=20480

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.digital_ocean_droplet_resize_request import DigitalOceanDropletResizeRequest # (1)
from waldur_api_client.api.digitalocean_droplets import digitalocean_droplets_resize # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = DigitalOceanDropletResizeRequest(
    size=100,
    disk=20480
)
response = digitalocean_droplets_resize.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: DigitalOceanDropletResizeRequest
  2. API Source: digitalocean_droplets_resize
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { digitaloceanDropletsResize } from 'waldur-js-client';

try {
  const response = await digitaloceanDropletsResize({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "size": 100,
    "disk": 20480
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
size string (uri) ✓
disk boolean ✓

200 -

Field Type
disk boolean

Restart

1
2
3
4
http \
  POST \
  https://api.example.com/api/digitalocean-droplets/a1b2c3d4-e5f6-7890-abcd-ef1234567890/restart/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.digitalocean_droplets import digitalocean_droplets_restart # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = digitalocean_droplets_restart.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: digitalocean_droplets_restart
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { digitaloceanDropletsRestart } from 'waldur-js-client';

try {
  const response = await digitaloceanDropletsRestart({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 - No response body

Mark resource as ERRED

Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.

1
2
3
4
http \
  POST \
  https://api.example.com/api/digitalocean-droplets/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_erred/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.set_erred_request import SetErredRequest # (1)
from waldur_api_client.api.digitalocean_droplets import digitalocean_droplets_set_erred # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = SetErredRequest()
response = digitalocean_droplets_set_erred.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: SetErredRequest
  2. API Source: digitalocean_droplets_set_erred
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { digitaloceanDropletsSetErred } from 'waldur-js-client';

try {
  const response = await digitaloceanDropletsSetErred({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
error_message string
error_traceback string

200 -

Field Type
detail string

Mark resource as OK

Manually transition the resource to OK state and clear error fields. Staff-only operation.

1
2
3
4
http \
  POST \
  https://api.example.com/api/digitalocean-droplets/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_ok/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.digitalocean_droplets import digitalocean_droplets_set_ok # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = digitalocean_droplets_set_ok.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: digitalocean_droplets_set_ok
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { digitaloceanDropletsSetOk } from 'waldur-js-client';

try {
  const response = await digitaloceanDropletsSetOk({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
detail string

Start

1
2
3
4
http \
  POST \
  https://api.example.com/api/digitalocean-droplets/a1b2c3d4-e5f6-7890-abcd-ef1234567890/start/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.digitalocean_droplets import digitalocean_droplets_start # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = digitalocean_droplets_start.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: digitalocean_droplets_start
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { digitaloceanDropletsStart } from 'waldur-js-client';

try {
  const response = await digitaloceanDropletsStart({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 - No response body

Stop

1
2
3
4
http \
  POST \
  https://api.example.com/api/digitalocean-droplets/a1b2c3d4-e5f6-7890-abcd-ef1234567890/stop/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.digitalocean_droplets import digitalocean_droplets_stop # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = digitalocean_droplets_stop.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: digitalocean_droplets_stop
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { digitaloceanDropletsStop } from 'waldur-js-client';

try {
  const response = await digitaloceanDropletsStop({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 - No response body

Digitalocean Images

Operations Summary

Method Endpoint Description
GET /api/digitalocean-images/ List Digitalocean Images
GET /api/digitalocean-images/{uuid}/ Retrieve

List Digitalocean Images

1
2
3
4
http \
  GET \
  https://api.example.com/api/digitalocean-images/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.digital_ocean_image_o_enum import DigitalOceanImageOEnum # (1)
from waldur_api_client.api.digitalocean_images import digitalocean_images_list # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = digitalocean_images_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: DigitalOceanImageOEnum
  2. API Source: digitalocean_images_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { digitaloceanImagesList } from 'waldur-js-client';

try {
  const response = await digitaloceanImagesList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
distribution string
name string Name
name_exact string Name (exact)
o array Ordering
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
type string

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
name string
distribution string
type string
regions array of objects
regions.url string (uri)
regions.uuid string (uuid)
regions.name string
is_official boolean Is image provided by DigitalOcean
created_at string (date-time)
min_disk_size integer Minimum disk required for a size to use this image

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/digitalocean-images/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.digitalocean_images import digitalocean_images_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = digitalocean_images_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: digitalocean_images_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { digitaloceanImagesRetrieve } from 'waldur-js-client';

try {
  const response = await digitaloceanImagesRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
distribution string
type string
regions array of objects
regions.url string (uri)
regions.uuid string (uuid)
regions.name string
is_official boolean Is image provided by DigitalOcean
created_at string (date-time)
min_disk_size integer Minimum disk required for a size to use this image

Digitalocean Regions

Operations Summary

Method Endpoint Description
GET /api/digitalocean-regions/ List Digitalocean Regions
GET /api/digitalocean-regions/{uuid}/ Retrieve

List Digitalocean Regions

1
2
3
4
http \
  GET \
  https://api.example.com/api/digitalocean-regions/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.digitalocean_regions import digitalocean_regions_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = digitalocean_regions_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: digitalocean_regions_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { digitaloceanRegionsList } from 'waldur-js-client';

try {
  const response = await digitaloceanRegionsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
name string Name
name_exact string Name (exact)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
url string (uri)
uuid string (uuid)
name string

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/digitalocean-regions/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.digitalocean_regions import digitalocean_regions_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = digitalocean_regions_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: digitalocean_regions_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { digitaloceanRegionsRetrieve } from 'waldur-js-client';

try {
  const response = await digitaloceanRegionsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
url string (uri)
uuid string (uuid)
name string

Digitalocean Sizes

Operations Summary

Method Endpoint Description
GET /api/digitalocean-sizes/ List Digitalocean Sizes
GET /api/digitalocean-sizes/{uuid}/ Retrieve

List Digitalocean Sizes

1
2
3
4
http \
  GET \
  https://api.example.com/api/digitalocean-sizes/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.digitalocean_sizes import digitalocean_sizes_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = digitalocean_sizes_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: digitalocean_sizes_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { digitaloceanSizesList } from 'waldur-js-client';

try {
  const response = await digitaloceanSizesList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
cores integer
disk integer
name string Name
name_exact string Name (exact)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
ram integer

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
name string
cores integer Number of cores in a VM
ram integer Memory size in MiB
disk integer Disk size in MiB
transfer integer Amount of transfer bandwidth in MiB
regions array of objects
regions.url string (uri)
regions.uuid string (uuid)
regions.name string

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/digitalocean-sizes/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.digitalocean_sizes import digitalocean_sizes_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = digitalocean_sizes_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: digitalocean_sizes_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { digitaloceanSizesRetrieve } from 'waldur-js-client';

try {
  const response = await digitaloceanSizesRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
cores integer Number of cores in a VM
ram integer Memory size in MiB
disk integer Disk size in MiB
transfer integer Amount of transfer bandwidth in MiB
regions array of objects
regions.url string (uri)
regions.uuid string (uuid)
regions.name string

Openportal

Openportal Allocation User Usage

Operations Summary

Method Endpoint Description
GET /api/openportal-allocation-user-usage/ List Openportal Allocation User Usage
GET /api/openportal-allocation-user-usage/{id}/ Retrieve

List Openportal Allocation User Usage

1
2
3
4
http \
  GET \
  https://api.example.com/api/openportal-allocation-user-usage/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openportal_allocation_user_usage import openportal_allocation_user_usage_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openportal_allocation_user_usage_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: openportal_allocation_user_usage_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { openportalAllocationUserUsageList } from 'waldur-js-client';

try {
  const response = await openportalAllocationUserUsageList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
allocation string (uri)
allocation_uuid string (uuid)
month integer
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
user string (uri)
user_uuid string (uuid)
year integer

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
node_usage string (decimal)
month integer
year integer
allocation string (uri)
user string (uri)
username string
full_name string

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/openportal-allocation-user-usage/123/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openportal_allocation_user_usage import openportal_allocation_user_usage_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openportal_allocation_user_usage_retrieve.sync(
    id=123,
    client=client
)

print(response)
  1. API Source: openportal_allocation_user_usage_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openportalAllocationUserUsageRetrieve } from 'waldur-js-client';

try {
  const response = await openportalAllocationUserUsageRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "id": 123
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
id integer ✓ A unique integer value identifying this allocation user usage.

200 -

Field Type
node_usage string (decimal)
month integer
year integer
allocation string (uri)
user string (uri)
username string
full_name string

Openportal Allocations

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/openportal-allocations/ List Openportal Allocations
GET /api/openportal-allocations/{uuid}/ Retrieve
POST /api/openportal-allocations/ Create
POST /api/openportal-allocations/{uuid}/pull/ Synchronize resource state
POST /api/openportal-allocations/{uuid}/unlink/ Unlink resource
PUT /api/openportal-allocations/{uuid}/ Update
PATCH /api/openportal-allocations/{uuid}/ Partial Update
DELETE /api/openportal-allocations/{uuid}/ Delete
Other Actions
POST /api/openportal-allocations/{uuid}/set_erred/ Mark resource as ERRED
POST /api/openportal-allocations/{uuid}/set_limits/ Set limits
POST /api/openportal-allocations/{uuid}/set_ok/ Mark resource as OK

Core CRUD

List Openportal Allocations

1
2
3
4
http \
  GET \
  https://api.example.com/api/openportal-allocations/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.allocation_field_enum import AllocationFieldEnum # (1)
from waldur_api_client.models.core_states import CoreStates # (2)
from waldur_api_client.api.openportal_allocations import openportal_allocations_list # (3)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openportal_allocations_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: AllocationFieldEnum
  2. Model Source: CoreStates
  3. API Source: openportal_allocations_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { openportalAllocationsList } from 'waldur-js-client';

try {
  const response = await openportalAllocationsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
backend_id string Backend ID
can_manage boolean Can manage
customer string (uuid) Customer UUID
customer_abbreviation string Customer abbreviation
customer_name string Customer name
customer_native_name string Customer native name
customer_uuid string (uuid) Customer UUID
description string Description
external_ip string External IP
field array
is_active boolean
name string Name
name_exact string Name (exact)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
project string (uuid) Project UUID
project_name string Project name
project_uuid string (uuid) Project UUID
service_settings_name string Service settings name
service_settings_uuid string (uuid) Service settings UUID
state array State
uuid string (uuid) UUID

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
node_limit integer (int64)
groupname string
node_usage string (decimal)
is_active boolean
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/openportal-allocations/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.allocation_field_enum import AllocationFieldEnum # (1)
from waldur_api_client.api.openportal_allocations import openportal_allocations_retrieve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openportal_allocations_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. Model Source: AllocationFieldEnum
  2. API Source: openportal_allocations_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openportalAllocationsRetrieve } from 'waldur-js-client';

try {
  const response = await openportalAllocationsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type
field array

200 -

Field Type
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
node_limit integer (int64)
groupname string
node_usage string (decimal)
is_active boolean
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Create

1
2
3
4
5
6
7
http \
  POST \
  https://api.example.com/api/openportal-allocations/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-openportal-allocation" \
  service_settings="https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.allocation_request import AllocationRequest # (1)
from waldur_api_client.api.openportal_allocations import openportal_allocations_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = AllocationRequest(
    name="my-awesome-openportal-allocation",
    service_settings="https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = openportal_allocations_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: AllocationRequest
  2. API Source: openportal_allocations_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
import { openportalAllocationsCreate } from 'waldur-js-client';

try {
  const response = await openportalAllocationsCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "name": "my-awesome-openportal-allocation",
    "service_settings": "https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "project": "https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required
name string ✓
description string
service_settings string (uri) ✓
project string (uri) ✓
node_limit integer (int64)
groupname string

201 -

Field Type
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
node_limit integer (int64)
groupname string
node_usage string (decimal)
is_active boolean
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Synchronize resource state

Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.

1
2
3
4
http \
  POST \
  https://api.example.com/api/openportal-allocations/a1b2c3d4-e5f6-7890-abcd-ef1234567890/pull/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openportal_allocations import openportal_allocations_pull # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openportal_allocations_pull.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openportal_allocations_pull
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openportalAllocationsPull } from 'waldur-js-client';

try {
  const response = await openportalAllocationsPull({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

202 -

Field Type
detail string

409 -

Field Type
detail string

Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state.

1
2
3
4
http \
  POST \
  https://api.example.com/api/openportal-allocations/a1b2c3d4-e5f6-7890-abcd-ef1234567890/unlink/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openportal_allocations import openportal_allocations_unlink # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openportal_allocations_unlink.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openportal_allocations_unlink
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openportalAllocationsUnlink } from 'waldur-js-client';

try {
  const response = await openportalAllocationsUnlink({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Update

1
2
3
4
5
6
7
http \
  PUT \
  https://api.example.com/api/openportal-allocations/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-openportal-allocation" \
  service_settings="https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.allocation_request import AllocationRequest # (1)
from waldur_api_client.api.openportal_allocations import openportal_allocations_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = AllocationRequest(
    name="my-awesome-openportal-allocation",
    service_settings="https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = openportal_allocations_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: AllocationRequest
  2. API Source: openportal_allocations_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
import { openportalAllocationsUpdate } from 'waldur-js-client';

try {
  const response = await openportalAllocationsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-openportal-allocation",
    "service_settings": "https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "project": "https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
name string ✓
description string
service_settings string (uri) ✓
project string (uri) ✓
node_limit integer (int64)
groupname string

200 -

Field Type
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
node_limit integer (int64)
groupname string
node_usage string (decimal)
is_active boolean
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/openportal-allocations/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_allocation_request import PatchedAllocationRequest # (1)
from waldur_api_client.api.openportal_allocations import openportal_allocations_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedAllocationRequest()
response = openportal_allocations_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedAllocationRequest
  2. API Source: openportal_allocations_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openportalAllocationsPartialUpdate } from 'waldur-js-client';

try {
  const response = await openportalAllocationsPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
name string
description string
node_limit integer (int64)
groupname string

200 -

Field Type
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
node_limit integer (int64)
groupname string
node_usage string (decimal)
is_active boolean
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/openportal-allocations/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openportal_allocations import openportal_allocations_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openportal_allocations_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openportal_allocations_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openportalAllocationsDestroy } from 'waldur-js-client';

try {
  const response = await openportalAllocationsDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Other Actions

Mark resource as ERRED

Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.

1
2
3
4
http \
  POST \
  https://api.example.com/api/openportal-allocations/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_erred/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.set_erred_request import SetErredRequest # (1)
from waldur_api_client.api.openportal_allocations import openportal_allocations_set_erred # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = SetErredRequest()
response = openportal_allocations_set_erred.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: SetErredRequest
  2. API Source: openportal_allocations_set_erred
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openportalAllocationsSetErred } from 'waldur-js-client';

try {
  const response = await openportalAllocationsSetErred({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
error_message string
error_traceback string

200 -

Field Type
detail string

Set limits

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/openportal-allocations/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_limits/ \
  Authorization:"Token YOUR_API_TOKEN" \
  node_limit=123

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.allocation_set_limits_request import AllocationSetLimitsRequest # (1)
from waldur_api_client.api.openportal_allocations import openportal_allocations_set_limits # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = AllocationSetLimitsRequest(
    node_limit=123
)
response = openportal_allocations_set_limits.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: AllocationSetLimitsRequest
  2. API Source: openportal_allocations_set_limits
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { openportalAllocationsSetLimits } from 'waldur-js-client';

try {
  const response = await openportalAllocationsSetLimits({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "node_limit": 123
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
node_limit integer ✓

200 -

Field Type
node_limit integer

Mark resource as OK

Manually transition the resource to OK state and clear error fields. Staff-only operation.

1
2
3
4
http \
  POST \
  https://api.example.com/api/openportal-allocations/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_ok/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openportal_allocations import openportal_allocations_set_ok # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openportal_allocations_set_ok.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openportal_allocations_set_ok
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openportalAllocationsSetOk } from 'waldur-js-client';

try {
  const response = await openportalAllocationsSetOk({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
detail string

Openportal Associations

Operations Summary

Method Endpoint Description
GET /api/openportal-associations/ List Openportal Associations
GET /api/openportal-associations/{uuid}/ Retrieve

List Openportal Associations

1
2
3
4
http \
  GET \
  https://api.example.com/api/openportal-associations/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openportal_associations import openportal_associations_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openportal_associations_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: openportal_associations_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { openportalAssociationsList } from 'waldur-js-client';

try {
  const response = await openportalAssociationsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
allocation string (uri)
allocation_uuid string (uuid)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
uuid string (uuid)
username string
groupname string
useridentifier string
allocation string (uri)

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/openportal-associations/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openportal_associations import openportal_associations_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openportal_associations_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openportal_associations_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openportalAssociationsRetrieve } from 'waldur-js-client';

try {
  const response = await openportalAssociationsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
uuid string (uuid)
username string
groupname string
useridentifier string
allocation string (uri)

Openportal Managed Projects

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/openportal-managed-projects/ List all managed projects
GET /api/openportal-managed-projects/{identifier}/{destination}/ Retrieve a managed project
Other Actions
POST /api/openportal-managed-projects/{identifier}/{destination}/approve/ Approve managed project request
POST /api/openportal-managed-projects/{identifier}/{destination}/attach/ Attach a project to this managed project
POST /api/openportal-managed-projects/{identifier}/{destination}/detach/ Detach the project from this managed project
POST /api/openportal-managed-projects/{identifier}/{destination}/reject/ Reject managed project request
DELETE /api/openportal-managed-projects/{identifier}/{destination}/delete/ Delete ManagedProject object

Core CRUD

List all managed projects

List all managed projects

1
2
3
4
http \
  GET \
  https://api.example.com/api/openportal-managed-projects/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.remote_project_update_request_state_enum import RemoteProjectUpdateRequestStateEnum # (1)
from waldur_api_client.api.openportal_managed_projects import openportal_managed_projects_list # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openportal_managed_projects_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: RemoteProjectUpdateRequestStateEnum
  2. API Source: openportal_managed_projects_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { openportalManagedProjectsList } from 'waldur-js-client';

try {
  const response = await openportalManagedProjectsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
identifier string
local_identifier string
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
project string (uri)
project_template string (uri)
project_template_uuid string (uuid)
project_uuid string (uuid)
state array

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
state string
created string (date-time)
reviewed_at string (date-time) Timestamp when the review was completed
reviewed_by_full_name string
reviewed_by_uuid string (uuid)
review_comment string Optional comment provided during review
identifier string
destination string The destination used to send instructions from the remote portal.
details any Details of the project as provided by the remote OpenPortal.
project string (uri)
project_data any
project_template string (uri)
project_template_data any
local_identifier string The local project identifier in this portal.

Retrieve a managed project

Retrieve a managed project

1
2
3
4
http \
  GET \
  https://api.example.com/api/openportal-managed-projects/string-value/string-value/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openportal_managed_projects import openportal_managed_projects_retrieve_get # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openportal_managed_projects_retrieve_get.sync(
    destination="string-value",
    identifier="string-value",
    client=client
)

print(response)
  1. API Source: openportal_managed_projects_retrieve_get
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { openportalManagedProjectsRetrieveGet } from 'waldur-js-client';

try {
  const response = await openportalManagedProjectsRetrieveGet({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "destination": "string-value",
    "identifier": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
destination string ✓ The destination of the managed project
identifier string ✓ The identifier of the managed project

200 -

Field Type Description
state string
created string (date-time)
reviewed_at string (date-time) Timestamp when the review was completed
reviewed_by_full_name string
reviewed_by_uuid string (uuid)
review_comment string Optional comment provided during review
identifier string
destination string The destination used to send instructions from the remote portal.
details any Details of the project as provided by the remote OpenPortal.
project string (uri)
project_data any
project_template string (uri)
project_template_data any
local_identifier string The local project identifier in this portal.

Other Actions

Approve managed project request

Approve managed project request

1
2
3
4
http \
  POST \
  https://api.example.com/api/openportal-managed-projects/string-value/string-value/approve/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.review_comment_request import ReviewCommentRequest # (1)
from waldur_api_client.api.openportal_managed_projects import openportal_managed_projects_approve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ReviewCommentRequest()
response = openportal_managed_projects_approve.sync(
    destination="string-value",
    identifier="string-value",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ReviewCommentRequest
  2. API Source: openportal_managed_projects_approve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { openportalManagedProjectsApprove } from 'waldur-js-client';

try {
  const response = await openportalManagedProjectsApprove({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "destination": "string-value",
    "identifier": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
destination string ✓ The destination of the managed project
identifier string ✓ The identifier of the managed project
Field Type Required Description
comment string Optional comment for review

200 - No response body

Attach a project to this managed project

Attach a project to this managed project

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/openportal-managed-projects/string-value/string-value/attach/ \
  Authorization:"Token YOUR_API_TOKEN" \
  project_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.project_attach_request import ProjectAttachRequest # (1)
from waldur_api_client.api.openportal_managed_projects import openportal_managed_projects_attach # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ProjectAttachRequest(
    project_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
)
response = openportal_managed_projects_attach.sync(
    destination="string-value",
    identifier="string-value",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ProjectAttachRequest
  2. API Source: openportal_managed_projects_attach
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { openportalManagedProjectsAttach } from 'waldur-js-client';

try {
  const response = await openportalManagedProjectsAttach({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "destination": "string-value",
    "identifier": "string-value"
  },
  body: {
    "project_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
destination string ✓ The destination of the managed project
identifier string ✓ The identifier of the managed project
Field Type Required Description
project_uuid string (uuid) ✓ UUID of the project to attach to this managed project

200 - No response body

Detach the project from this managed project

Detach the project from this managed project

1
2
3
4
http \
  POST \
  https://api.example.com/api/openportal-managed-projects/string-value/string-value/detach/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openportal_managed_projects import openportal_managed_projects_detach # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openportal_managed_projects_detach.sync(
    destination="string-value",
    identifier="string-value",
    client=client
)

print(response)
  1. API Source: openportal_managed_projects_detach
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { openportalManagedProjectsDetach } from 'waldur-js-client';

try {
  const response = await openportalManagedProjectsDetach({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "destination": "string-value",
    "identifier": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
destination string ✓ The destination of the managed project
identifier string ✓ The identifier of the managed project

200 - No response body

Reject managed project request

Reject managed project request

1
2
3
4
http \
  POST \
  https://api.example.com/api/openportal-managed-projects/string-value/string-value/reject/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.review_comment_request import ReviewCommentRequest # (1)
from waldur_api_client.api.openportal_managed_projects import openportal_managed_projects_reject # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ReviewCommentRequest()
response = openportal_managed_projects_reject.sync(
    destination="string-value",
    identifier="string-value",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ReviewCommentRequest
  2. API Source: openportal_managed_projects_reject
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { openportalManagedProjectsReject } from 'waldur-js-client';

try {
  const response = await openportalManagedProjectsReject({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "destination": "string-value",
    "identifier": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
destination string ✓ The destination of the managed project
identifier string ✓ The identifier of the managed project
Field Type Required Description
comment string Optional comment for review

200 - No response body

Delete ManagedProject object

Delete ManagedProject object

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/openportal-managed-projects/string-value/string-value/delete/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openportal_managed_projects import openportal_managed_projects_delete_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openportal_managed_projects_delete_destroy.sync(
    destination="string-value",
    identifier="string-value",
    client=client
)

print(response)
  1. API Source: openportal_managed_projects_delete_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { openportalManagedProjectsDeleteDestroy } from 'waldur-js-client';

try {
  const response = await openportalManagedProjectsDeleteDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "destination": "string-value",
    "identifier": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
destination string ✓ The destination of the managed project
identifier string ✓ The identifier of the managed project

204 - No response body

Openportal Project Template

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/openportal-project-template/ List Openportal Project Template
GET /api/openportal-project-template/{uuid}/ Retrieve
POST /api/openportal-project-template/ Create ProjectTemplate object
PUT /api/openportal-project-template/{uuid}/ Update ProjectTemplate object (full update)
PATCH /api/openportal-project-template/{uuid}/ Partially update ProjectTemplate object
DELETE /api/openportal-project-template/{uuid}/ Delete
Other Actions
DELETE /api/openportal-project-template/{uuid}/delete/ Delete ProjectTemplate object

Core CRUD

List Openportal Project Template

1
2
3
4
http \
  GET \
  https://api.example.com/api/openportal-project-template/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openportal_project_template import openportal_project_template_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openportal_project_template_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: openportal_project_template_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { openportalProjectTemplateList } from 'waldur-js-client';

try {
  const response = await openportalProjectTemplateList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
name string
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
portal string
uuid string (uuid)

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid)
name string
offering string The offering for which this template applies.
provider string (uri)
provider_data any
portal string
key string The key that is used to authenticate requests for this class.
customer string (uri)
customer_data any
shortname string
offerings array of string (uri)s
offerings_data array of objects
offerings_data.url string (uri)
offerings_data.uuid string (uuid)
offerings_data.created string (date-time)
offerings_data.name string
offerings_data.slug string URL-friendly identifier. Only editable by staff users.
offerings_data.description string
offerings_data.full_description string
offerings_data.privacy_policy_link string (uri)
offerings_data.access_url string (uri) Publicly accessible offering access URL
offerings_data.endpoints array of objects
offerings_data.endpoints.uuid string (uuid)
offerings_data.endpoints.name string
offerings_data.endpoints.url string URL of the access endpoint
offerings_data.software_catalogs array of objects
offerings_data.software_catalogs.uuid string (uuid)
offerings_data.software_catalogs.catalog any
offerings_data.software_catalogs.enabled_cpu_family any List of enabled CPU families: ['x86_64', 'aarch64']
offerings_data.software_catalogs.enabled_cpu_microarchitectures any List of enabled CPU microarchitectures: ['generic', 'zen3']
offerings_data.software_catalogs.package_count integer
offerings_data.software_catalogs.partition any
offerings_data.partitions array of objects
offerings_data.partitions.uuid string (uuid)
offerings_data.partitions.partition_name string Name of the SLURM partition
offerings_data.partitions.cpu_bind integer Default task binding policy (SLURM cpu_bind)
offerings_data.partitions.def_cpu_per_gpu integer Default CPUs allocated per GPU
offerings_data.partitions.max_cpus_per_node integer Maximum allocated CPUs per node
offerings_data.partitions.max_cpus_per_socket integer Maximum allocated CPUs per socket
offerings_data.partitions.def_mem_per_cpu integer (int64) Default memory per CPU in MB
offerings_data.partitions.def_mem_per_gpu integer (int64) Default memory per GPU in MB
offerings_data.partitions.def_mem_per_node integer (int64) Default memory per node in MB
offerings_data.partitions.max_mem_per_cpu integer (int64) Maximum memory per CPU in MB
offerings_data.partitions.max_mem_per_node integer (int64) Maximum memory per node in MB
offerings_data.partitions.default_time integer Default time limit in minutes
offerings_data.partitions.max_time integer Maximum time limit in minutes
offerings_data.partitions.grace_time integer Preemption grace time in seconds
offerings_data.partitions.max_nodes integer Maximum nodes per job
offerings_data.partitions.min_nodes integer Minimum nodes per job
offerings_data.partitions.exclusive_topo boolean Exclusive topology access required
offerings_data.partitions.exclusive_user boolean Exclusive user access required
offerings_data.partitions.priority_tier integer Priority tier for scheduling and preemption
offerings_data.partitions.qos string Quality of Service (QOS) name
offerings_data.partitions.req_resv boolean Require reservation for job allocation
offerings_data.roles array of objects
offerings_data.roles.uuid string (uuid)
offerings_data.roles.name string
offerings_data.roles.url string (uri)
offerings_data.customer string (uri)
offerings_data.customer_uuid string (uuid)
offerings_data.customer_name string
offerings_data.project string (uri)
offerings_data.project_uuid string (uuid)
offerings_data.project_name string
offerings_data.category string (uri)
offerings_data.category_uuid string (uuid)
offerings_data.category_title string
offerings_data.attributes object (free-form)
offerings_data.options any
offerings_data.resource_options any
offerings_data.components array of objects
offerings_data.components.uuid string (uuid)
offerings_data.components.billing_type string
Enum: fixed, usage, limit, one, few
offerings_data.components.type string Unique internal name of the measured unit, for example floating_ip.
offerings_data.components.name string Display name for the measured unit, for example, Floating IP.
offerings_data.components.description string
offerings_data.components.measured_unit string Unit of measurement, for example, GB.
offerings_data.components.unit_factor integer The conversion factor from backend units to measured_unit
offerings_data.components.limit_period any
offerings_data.components.limit_amount integer
offerings_data.components.article_code string
offerings_data.components.max_value integer
offerings_data.components.min_value integer
offerings_data.components.max_available_limit integer
offerings_data.components.is_boolean boolean
offerings_data.components.default_limit integer
offerings_data.components.factor integer
offerings_data.components.is_builtin boolean
offerings_data.components.is_prepaid boolean
offerings_data.components.overage_component string (uuid)
offerings_data.components.min_prepaid_duration integer
offerings_data.components.max_prepaid_duration integer
offerings_data.plugin_options any
offerings_data.secret_options any
offerings_data.service_attributes object (free-form)
offerings_data.state any
offerings_data.vendor_details string
offerings_data.getting_started string
offerings_data.integration_guide string
offerings_data.thumbnail string (uri)
offerings_data.order_count integer
offerings_data.plans array of objects
offerings_data.plans.url string (uri)
offerings_data.plans.uuid string (uuid)
offerings_data.plans.name string
offerings_data.plans.description string
offerings_data.plans.article_code string
offerings_data.plans.max_amount integer Maximum number of plans that could be active. Plan is disabled when maximum amount is reached.
offerings_data.plans.archived boolean Forbids creation of new resources.
offerings_data.plans.is_active boolean
offerings_data.plans.unit_price string (decimal)
offerings_data.plans.unit string
Enum: month, quarter, half_month, day, hour, quantity
offerings_data.plans.init_price number (double)
offerings_data.plans.switch_price number (double)
offerings_data.plans.backend_id string
offerings_data.plans.organization_groups array of objects
offerings_data.plans.organization_groups.uuid string (uuid)
offerings_data.plans.organization_groups.url string (uri)
offerings_data.plans.organization_groups.name string
offerings_data.plans.organization_groups.parent_uuid string (uuid) UUID of the parent organization group
offerings_data.plans.organization_groups.parent_name string Name of the parent organization group
offerings_data.plans.organization_groups.parent string (uri)
offerings_data.plans.organization_groups.customers_count integer Number of customers in this organization group
offerings_data.plans.components array of objects
offerings_data.plans.components.type string Unique internal name of the measured unit, for example floating_ip.
offerings_data.plans.components.name string Display name for the measured unit, for example, Floating IP.
offerings_data.plans.components.measured_unit string Unit of measurement, for example, GB.
offerings_data.plans.components.amount integer
offerings_data.plans.components.price string (decimal)
offerings_data.plans.components.future_price string (decimal)
offerings_data.plans.components.discount_threshold integer Minimum amount to be eligible for discount.
offerings_data.plans.components.discount_rate integer Discount rate in percentage.
offerings_data.plans.prices object (free-form)
offerings_data.plans.future_prices object (free-form)
offerings_data.plans.quotas object (free-form)
offerings_data.plans.resources_count integer
offerings_data.plans.plan_type string
offerings_data.plans.minimal_price number (double)
offerings_data.screenshots array of objects
offerings_data.screenshots.name string
offerings_data.screenshots.uuid string (uuid)
offerings_data.screenshots.description string
offerings_data.screenshots.image string (uri)
offerings_data.screenshots.thumbnail string (uri)
offerings_data.screenshots.created string (date-time)
offerings_data.type string
offerings_data.shared boolean Accessible to all customers.
offerings_data.billable boolean Purchase and usage is invoiced.
offerings_data.scope string
offerings_data.scope_uuid string (uuid)
offerings_data.scope_name string (uuid)
offerings_data.scope_state any
offerings_data.scope_error_message string
offerings_data.files array of objects
offerings_data.files.name string
offerings_data.files.created string (date-time)
offerings_data.files.file string (uri)
offerings_data.quotas array of objects
offerings_data.quotas.name string
offerings_data.quotas.usage integer
offerings_data.quotas.limit integer
offerings_data.paused_reason string
offerings_data.datacite_doi string
offerings_data.citation_count integer Number of citations of a DOI
offerings_data.latitude number (double)
offerings_data.longitude number (double)
offerings_data.country any Country code (ISO 3166-1 alpha-2)
offerings_data.backend_id string
offerings_data.backend_id_rules any Validation rules for resource backend_id: format regex and uniqueness scope.
offerings_data.organization_groups array of objects
offerings_data.organization_groups.uuid string (uuid)
offerings_data.organization_groups.url string (uri)
offerings_data.organization_groups.name string
offerings_data.organization_groups.parent_uuid string (uuid) UUID of the parent organization group
offerings_data.organization_groups.parent_name string Name of the parent organization group
offerings_data.organization_groups.parent string (uri)
offerings_data.organization_groups.customers_count integer Number of customers in this organization group
offerings_data.tags array of objects
offerings_data.tags.uuid string (uuid)
offerings_data.tags.name string
offerings_data.image string (uri)
offerings_data.total_customers integer
offerings_data.total_cost integer
offerings_data.total_cost_estimated integer
offerings_data.parent_description string
offerings_data.parent_uuid string (uuid)
offerings_data.parent_name string
offerings_data.backend_metadata any
offerings_data.has_compliance_requirements boolean
offerings_data.billing_type_classification string Classify offering components by billing type. Returns 'limit_only', 'usage_only', or 'mixed'.
offerings_data.compliance_checklist string (uri)
offerings_data.integration_status array of objects
offerings_data.integration_status.agent_type any
offerings_data.integration_status.status string
offerings_data.integration_status.last_request_timestamp string (date-time)
offerings_data.integration_status.service_name string
offerings_data.google_calendar_is_public boolean
offerings_data.google_calendar_link string Get the Google Calendar link for an offering.
approval_limit string (decimal) The credit limit beyond which requests need to be approved by a local admin. If this is None, then no local approval is required. If this is set to 0, then all requests (including creating the project) need to be approved.
max_credit_limit string (decimal) The maximum credit limit for any projects created in this class. Any requests beyond this limit are automatically rejected. If this is None, then no maximum limit is set. If this is set to 0, then no projects can be created in this class.
allocation_units_mapping any The mapping of credits to allocation units, i.e. how many allocation units to award per credit allocated.
role_mapping any The mapping of role names from the remote portal to role information in this portal for users in projects created in this class.
role_mapping_data object (free-form) Serialize the role mapping dictionary returned by get_role_mapping()

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/openportal-project-template/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openportal_project_template import openportal_project_template_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openportal_project_template_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openportal_project_template_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openportalProjectTemplateRetrieve } from 'waldur-js-client';

try {
  const response = await openportalProjectTemplateRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
uuid string (uuid)
name string
offering string The offering for which this template applies.
provider string (uri)
provider_data any
portal string
key string The key that is used to authenticate requests for this class.
customer string (uri)
customer_data any
shortname string
offerings array of string (uri)s
offerings_data array of objects
offerings_data.url string (uri)
offerings_data.uuid string (uuid)
offerings_data.created string (date-time)
offerings_data.name string
offerings_data.slug string URL-friendly identifier. Only editable by staff users.
offerings_data.description string
offerings_data.full_description string
offerings_data.privacy_policy_link string (uri)
offerings_data.access_url string (uri) Publicly accessible offering access URL
offerings_data.endpoints array of objects
offerings_data.endpoints.uuid string (uuid)
offerings_data.endpoints.name string
offerings_data.endpoints.url string URL of the access endpoint
offerings_data.software_catalogs array of objects
offerings_data.software_catalogs.uuid string (uuid)
offerings_data.software_catalogs.catalog any
offerings_data.software_catalogs.enabled_cpu_family any List of enabled CPU families: ['x86_64', 'aarch64']
offerings_data.software_catalogs.enabled_cpu_microarchitectures any List of enabled CPU microarchitectures: ['generic', 'zen3']
offerings_data.software_catalogs.package_count integer
offerings_data.software_catalogs.partition any
offerings_data.partitions array of objects
offerings_data.partitions.uuid string (uuid)
offerings_data.partitions.partition_name string Name of the SLURM partition
offerings_data.partitions.cpu_bind integer Default task binding policy (SLURM cpu_bind)
offerings_data.partitions.def_cpu_per_gpu integer Default CPUs allocated per GPU
offerings_data.partitions.max_cpus_per_node integer Maximum allocated CPUs per node
offerings_data.partitions.max_cpus_per_socket integer Maximum allocated CPUs per socket
offerings_data.partitions.def_mem_per_cpu integer (int64) Default memory per CPU in MB
offerings_data.partitions.def_mem_per_gpu integer (int64) Default memory per GPU in MB
offerings_data.partitions.def_mem_per_node integer (int64) Default memory per node in MB
offerings_data.partitions.max_mem_per_cpu integer (int64) Maximum memory per CPU in MB
offerings_data.partitions.max_mem_per_node integer (int64) Maximum memory per node in MB
offerings_data.partitions.default_time integer Default time limit in minutes
offerings_data.partitions.max_time integer Maximum time limit in minutes
offerings_data.partitions.grace_time integer Preemption grace time in seconds
offerings_data.partitions.max_nodes integer Maximum nodes per job
offerings_data.partitions.min_nodes integer Minimum nodes per job
offerings_data.partitions.exclusive_topo boolean Exclusive topology access required
offerings_data.partitions.exclusive_user boolean Exclusive user access required
offerings_data.partitions.priority_tier integer Priority tier for scheduling and preemption
offerings_data.partitions.qos string Quality of Service (QOS) name
offerings_data.partitions.req_resv boolean Require reservation for job allocation
offerings_data.roles array of objects
offerings_data.roles.uuid string (uuid)
offerings_data.roles.name string
offerings_data.roles.url string (uri)
offerings_data.customer string (uri)
offerings_data.customer_uuid string (uuid)
offerings_data.customer_name string
offerings_data.project string (uri)
offerings_data.project_uuid string (uuid)
offerings_data.project_name string
offerings_data.category string (uri)
offerings_data.category_uuid string (uuid)
offerings_data.category_title string
offerings_data.attributes object (free-form)
offerings_data.options any
offerings_data.resource_options any
offerings_data.components array of objects
offerings_data.components.uuid string (uuid)
offerings_data.components.billing_type string
Enum: fixed, usage, limit, one, few
offerings_data.components.type string Unique internal name of the measured unit, for example floating_ip.
offerings_data.components.name string Display name for the measured unit, for example, Floating IP.
offerings_data.components.description string
offerings_data.components.measured_unit string Unit of measurement, for example, GB.
offerings_data.components.unit_factor integer The conversion factor from backend units to measured_unit
offerings_data.components.limit_period any
offerings_data.components.limit_amount integer
offerings_data.components.article_code string
offerings_data.components.max_value integer
offerings_data.components.min_value integer
offerings_data.components.max_available_limit integer
offerings_data.components.is_boolean boolean
offerings_data.components.default_limit integer
offerings_data.components.factor integer
offerings_data.components.is_builtin boolean
offerings_data.components.is_prepaid boolean
offerings_data.components.overage_component string (uuid)
offerings_data.components.min_prepaid_duration integer
offerings_data.components.max_prepaid_duration integer
offerings_data.plugin_options any
offerings_data.secret_options any
offerings_data.service_attributes object (free-form)
offerings_data.state any
offerings_data.vendor_details string
offerings_data.getting_started string
offerings_data.integration_guide string
offerings_data.thumbnail string (uri)
offerings_data.order_count integer
offerings_data.plans array of objects
offerings_data.plans.url string (uri)
offerings_data.plans.uuid string (uuid)
offerings_data.plans.name string
offerings_data.plans.description string
offerings_data.plans.article_code string
offerings_data.plans.max_amount integer Maximum number of plans that could be active. Plan is disabled when maximum amount is reached.
offerings_data.plans.archived boolean Forbids creation of new resources.
offerings_data.plans.is_active boolean
offerings_data.plans.unit_price string (decimal)
offerings_data.plans.unit string
Enum: month, quarter, half_month, day, hour, quantity
offerings_data.plans.init_price number (double)
offerings_data.plans.switch_price number (double)
offerings_data.plans.backend_id string
offerings_data.plans.organization_groups array of objects
offerings_data.plans.organization_groups.uuid string (uuid)
offerings_data.plans.organization_groups.url string (uri)
offerings_data.plans.organization_groups.name string
offerings_data.plans.organization_groups.parent_uuid string (uuid) UUID of the parent organization group
offerings_data.plans.organization_groups.parent_name string Name of the parent organization group
offerings_data.plans.organization_groups.parent string (uri)
offerings_data.plans.organization_groups.customers_count integer Number of customers in this organization group
offerings_data.plans.components array of objects
offerings_data.plans.components.type string Unique internal name of the measured unit, for example floating_ip.
offerings_data.plans.components.name string Display name for the measured unit, for example, Floating IP.
offerings_data.plans.components.measured_unit string Unit of measurement, for example, GB.
offerings_data.plans.components.amount integer
offerings_data.plans.components.price string (decimal)
offerings_data.plans.components.future_price string (decimal)
offerings_data.plans.components.discount_threshold integer Minimum amount to be eligible for discount.
offerings_data.plans.components.discount_rate integer Discount rate in percentage.
offerings_data.plans.prices object (free-form)
offerings_data.plans.future_prices object (free-form)
offerings_data.plans.quotas object (free-form)
offerings_data.plans.resources_count integer
offerings_data.plans.plan_type string
offerings_data.plans.minimal_price number (double)
offerings_data.screenshots array of objects
offerings_data.screenshots.name string
offerings_data.screenshots.uuid string (uuid)
offerings_data.screenshots.description string
offerings_data.screenshots.image string (uri)
offerings_data.screenshots.thumbnail string (uri)
offerings_data.screenshots.created string (date-time)
offerings_data.type string
offerings_data.shared boolean Accessible to all customers.
offerings_data.billable boolean Purchase and usage is invoiced.
offerings_data.scope string
offerings_data.scope_uuid string (uuid)
offerings_data.scope_name string (uuid)
offerings_data.scope_state any
offerings_data.scope_error_message string
offerings_data.files array of objects
offerings_data.files.name string
offerings_data.files.created string (date-time)
offerings_data.files.file string (uri)
offerings_data.quotas array of objects
offerings_data.quotas.name string
offerings_data.quotas.usage integer
offerings_data.quotas.limit integer
offerings_data.paused_reason string
offerings_data.datacite_doi string
offerings_data.citation_count integer Number of citations of a DOI
offerings_data.latitude number (double)
offerings_data.longitude number (double)
offerings_data.country any Country code (ISO 3166-1 alpha-2)
offerings_data.backend_id string
offerings_data.backend_id_rules any Validation rules for resource backend_id: format regex and uniqueness scope.
offerings_data.organization_groups array of objects
offerings_data.organization_groups.uuid string (uuid)
offerings_data.organization_groups.url string (uri)
offerings_data.organization_groups.name string
offerings_data.organization_groups.parent_uuid string (uuid) UUID of the parent organization group
offerings_data.organization_groups.parent_name string Name of the parent organization group
offerings_data.organization_groups.parent string (uri)
offerings_data.organization_groups.customers_count integer Number of customers in this organization group
offerings_data.tags array of objects
offerings_data.tags.uuid string (uuid)
offerings_data.tags.name string
offerings_data.image string (uri)
offerings_data.total_customers integer
offerings_data.total_cost integer
offerings_data.total_cost_estimated integer
offerings_data.parent_description string
offerings_data.parent_uuid string (uuid)
offerings_data.parent_name string
offerings_data.backend_metadata any
offerings_data.has_compliance_requirements boolean
offerings_data.billing_type_classification string Classify offering components by billing type. Returns 'limit_only', 'usage_only', or 'mixed'.
offerings_data.compliance_checklist string (uri)
offerings_data.integration_status array of objects
offerings_data.integration_status.agent_type any
offerings_data.integration_status.status string
offerings_data.integration_status.last_request_timestamp string (date-time)
offerings_data.integration_status.service_name string
offerings_data.google_calendar_is_public boolean
offerings_data.google_calendar_link string Get the Google Calendar link for an offering.
approval_limit string (decimal) The credit limit beyond which requests need to be approved by a local admin. If this is None, then no local approval is required. If this is set to 0, then all requests (including creating the project) need to be approved.
max_credit_limit string (decimal) The maximum credit limit for any projects created in this class. Any requests beyond this limit are automatically rejected. If this is None, then no maximum limit is set. If this is set to 0, then no projects can be created in this class.
allocation_units_mapping any The mapping of credits to allocation units, i.e. how many allocation units to award per credit allocated.
role_mapping any The mapping of role names from the remote portal to role information in this portal for users in projects created in this class.
role_mapping_data object (free-form) Serialize the role mapping dictionary returned by get_role_mapping()

Create ProjectTemplate object

Create ProjectTemplate object

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
http \
  POST \
  https://api.example.com/api/openportal-project-template/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-openportal-project-template" \
  offering="string-value" \
  provider="https://api.example.com/api/provider/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  portal="string-value" \
  customer="https://api.example.com/api/customer/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  offerings:='[]'

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.project_template_request import ProjectTemplateRequest # (1)
from waldur_api_client.api.openportal_project_template import openportal_project_template_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ProjectTemplateRequest(
    name="my-awesome-openportal-project-template",
    offering="string-value",
    provider="https://api.example.com/api/provider/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    portal="string-value",
    customer="https://api.example.com/api/customer/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    offerings=[]
)
response = openportal_project_template_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ProjectTemplateRequest
  2. API Source: openportal_project_template_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
import { openportalProjectTemplateCreate } from 'waldur-js-client';

try {
  const response = await openportalProjectTemplateCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "name": "my-awesome-openportal-project-template",
    "offering": "string-value",
    "provider": "https://api.example.com/api/provider/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "portal": "string-value",
    "customer": "https://api.example.com/api/customer/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "offerings": []
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
name string ✓
offering string ✓ The offering for which this template applies.
provider string (uri) ✓
portal string ✓
key string The key that is used to authenticate requests for this class.
customer string (uri) ✓
shortname string
offerings array of string (uri)s ✓
approval_limit string (decimal) The credit limit beyond which requests need to be approved by a local admin. If this is None, then no local approval is required. If this is set to 0, then all requests (including creating the project) need to be approved.
max_credit_limit string (decimal) The maximum credit limit for any projects created in this class. Any requests beyond this limit are automatically rejected. If this is None, then no maximum limit is set. If this is set to 0, then no projects can be created in this class.
allocation_units_mapping any The mapping of credits to allocation units, i.e. how many allocation units to award per credit allocated.
role_mapping any The mapping of role names from the remote portal to role information in this portal for users in projects created in this class.

201 -

Field Type Description
uuid string (uuid)
name string
offering string The offering for which this template applies.
provider string (uri)
provider_data any
portal string
key string The key that is used to authenticate requests for this class.
customer string (uri)
customer_data any
shortname string
offerings array of string (uri)s
offerings_data array of objects
offerings_data.url string (uri)
offerings_data.uuid string (uuid)
offerings_data.created string (date-time)
offerings_data.name string
offerings_data.slug string URL-friendly identifier. Only editable by staff users.
offerings_data.description string
offerings_data.full_description string
offerings_data.privacy_policy_link string (uri)
offerings_data.access_url string (uri) Publicly accessible offering access URL
offerings_data.endpoints array of objects
offerings_data.endpoints.uuid string (uuid)
offerings_data.endpoints.name string
offerings_data.endpoints.url string URL of the access endpoint
offerings_data.software_catalogs array of objects
offerings_data.software_catalogs.uuid string (uuid)
offerings_data.software_catalogs.catalog any
offerings_data.software_catalogs.enabled_cpu_family any List of enabled CPU families: ['x86_64', 'aarch64']
offerings_data.software_catalogs.enabled_cpu_microarchitectures any List of enabled CPU microarchitectures: ['generic', 'zen3']
offerings_data.software_catalogs.package_count integer
offerings_data.software_catalogs.partition any
offerings_data.partitions array of objects
offerings_data.partitions.uuid string (uuid)
offerings_data.partitions.partition_name string Name of the SLURM partition
offerings_data.partitions.cpu_bind integer Default task binding policy (SLURM cpu_bind)
offerings_data.partitions.def_cpu_per_gpu integer Default CPUs allocated per GPU
offerings_data.partitions.max_cpus_per_node integer Maximum allocated CPUs per node
offerings_data.partitions.max_cpus_per_socket integer Maximum allocated CPUs per socket
offerings_data.partitions.def_mem_per_cpu integer (int64) Default memory per CPU in MB
offerings_data.partitions.def_mem_per_gpu integer (int64) Default memory per GPU in MB
offerings_data.partitions.def_mem_per_node integer (int64) Default memory per node in MB
offerings_data.partitions.max_mem_per_cpu integer (int64) Maximum memory per CPU in MB
offerings_data.partitions.max_mem_per_node integer (int64) Maximum memory per node in MB
offerings_data.partitions.default_time integer Default time limit in minutes
offerings_data.partitions.max_time integer Maximum time limit in minutes
offerings_data.partitions.grace_time integer Preemption grace time in seconds
offerings_data.partitions.max_nodes integer Maximum nodes per job
offerings_data.partitions.min_nodes integer Minimum nodes per job
offerings_data.partitions.exclusive_topo boolean Exclusive topology access required
offerings_data.partitions.exclusive_user boolean Exclusive user access required
offerings_data.partitions.priority_tier integer Priority tier for scheduling and preemption
offerings_data.partitions.qos string Quality of Service (QOS) name
offerings_data.partitions.req_resv boolean Require reservation for job allocation
offerings_data.roles array of objects
offerings_data.roles.uuid string (uuid)
offerings_data.roles.name string
offerings_data.roles.url string (uri)
offerings_data.customer string (uri)
offerings_data.customer_uuid string (uuid)
offerings_data.customer_name string
offerings_data.project string (uri)
offerings_data.project_uuid string (uuid)
offerings_data.project_name string
offerings_data.category string (uri)
offerings_data.category_uuid string (uuid)
offerings_data.category_title string
offerings_data.attributes object (free-form)
offerings_data.options any
offerings_data.resource_options any
offerings_data.components array of objects
offerings_data.components.uuid string (uuid)
offerings_data.components.billing_type string
Enum: fixed, usage, limit, one, few
offerings_data.components.type string Unique internal name of the measured unit, for example floating_ip.
offerings_data.components.name string Display name for the measured unit, for example, Floating IP.
offerings_data.components.description string
offerings_data.components.measured_unit string Unit of measurement, for example, GB.
offerings_data.components.unit_factor integer The conversion factor from backend units to measured_unit
offerings_data.components.limit_period any
offerings_data.components.limit_amount integer
offerings_data.components.article_code string
offerings_data.components.max_value integer
offerings_data.components.min_value integer
offerings_data.components.max_available_limit integer
offerings_data.components.is_boolean boolean
offerings_data.components.default_limit integer
offerings_data.components.factor integer
offerings_data.components.is_builtin boolean
offerings_data.components.is_prepaid boolean
offerings_data.components.overage_component string (uuid)
offerings_data.components.min_prepaid_duration integer
offerings_data.components.max_prepaid_duration integer
offerings_data.plugin_options any
offerings_data.secret_options any
offerings_data.service_attributes object (free-form)
offerings_data.state any
offerings_data.vendor_details string
offerings_data.getting_started string
offerings_data.integration_guide string
offerings_data.thumbnail string (uri)
offerings_data.order_count integer
offerings_data.plans array of objects
offerings_data.plans.url string (uri)
offerings_data.plans.uuid string (uuid)
offerings_data.plans.name string
offerings_data.plans.description string
offerings_data.plans.article_code string
offerings_data.plans.max_amount integer Maximum number of plans that could be active. Plan is disabled when maximum amount is reached.
offerings_data.plans.archived boolean Forbids creation of new resources.
offerings_data.plans.is_active boolean
offerings_data.plans.unit_price string (decimal)
offerings_data.plans.unit string
Enum: month, quarter, half_month, day, hour, quantity
offerings_data.plans.init_price number (double)
offerings_data.plans.switch_price number (double)
offerings_data.plans.backend_id string
offerings_data.plans.organization_groups array of objects
offerings_data.plans.organization_groups.uuid string (uuid)
offerings_data.plans.organization_groups.url string (uri)
offerings_data.plans.organization_groups.name string
offerings_data.plans.organization_groups.parent_uuid string (uuid) UUID of the parent organization group
offerings_data.plans.organization_groups.parent_name string Name of the parent organization group
offerings_data.plans.organization_groups.parent string (uri)
offerings_data.plans.organization_groups.customers_count integer Number of customers in this organization group
offerings_data.plans.components array of objects
offerings_data.plans.components.type string Unique internal name of the measured unit, for example floating_ip.
offerings_data.plans.components.name string Display name for the measured unit, for example, Floating IP.
offerings_data.plans.components.measured_unit string Unit of measurement, for example, GB.
offerings_data.plans.components.amount integer
offerings_data.plans.components.price string (decimal)
offerings_data.plans.components.future_price string (decimal)
offerings_data.plans.components.discount_threshold integer Minimum amount to be eligible for discount.
offerings_data.plans.components.discount_rate integer Discount rate in percentage.
offerings_data.plans.prices object (free-form)
offerings_data.plans.future_prices object (free-form)
offerings_data.plans.quotas object (free-form)
offerings_data.plans.resources_count integer
offerings_data.plans.plan_type string
offerings_data.plans.minimal_price number (double)
offerings_data.screenshots array of objects
offerings_data.screenshots.name string
offerings_data.screenshots.uuid string (uuid)
offerings_data.screenshots.description string
offerings_data.screenshots.image string (uri)
offerings_data.screenshots.thumbnail string (uri)
offerings_data.screenshots.created string (date-time)
offerings_data.type string
offerings_data.shared boolean Accessible to all customers.
offerings_data.billable boolean Purchase and usage is invoiced.
offerings_data.scope string
offerings_data.scope_uuid string (uuid)
offerings_data.scope_name string (uuid)
offerings_data.scope_state any
offerings_data.scope_error_message string
offerings_data.files array of objects
offerings_data.files.name string
offerings_data.files.created string (date-time)
offerings_data.files.file string (uri)
offerings_data.quotas array of objects
offerings_data.quotas.name string
offerings_data.quotas.usage integer
offerings_data.quotas.limit integer
offerings_data.paused_reason string
offerings_data.datacite_doi string
offerings_data.citation_count integer Number of citations of a DOI
offerings_data.latitude number (double)
offerings_data.longitude number (double)
offerings_data.country any Country code (ISO 3166-1 alpha-2)
offerings_data.backend_id string
offerings_data.backend_id_rules any Validation rules for resource backend_id: format regex and uniqueness scope.
offerings_data.organization_groups array of objects
offerings_data.organization_groups.uuid string (uuid)
offerings_data.organization_groups.url string (uri)
offerings_data.organization_groups.name string
offerings_data.organization_groups.parent_uuid string (uuid) UUID of the parent organization group
offerings_data.organization_groups.parent_name string Name of the parent organization group
offerings_data.organization_groups.parent string (uri)
offerings_data.organization_groups.customers_count integer Number of customers in this organization group
offerings_data.tags array of objects
offerings_data.tags.uuid string (uuid)
offerings_data.tags.name string
offerings_data.image string (uri)
offerings_data.total_customers integer
offerings_data.total_cost integer
offerings_data.total_cost_estimated integer
offerings_data.parent_description string
offerings_data.parent_uuid string (uuid)
offerings_data.parent_name string
offerings_data.backend_metadata any
offerings_data.has_compliance_requirements boolean
offerings_data.billing_type_classification string Classify offering components by billing type. Returns 'limit_only', 'usage_only', or 'mixed'.
offerings_data.compliance_checklist string (uri)
offerings_data.integration_status array of objects
offerings_data.integration_status.agent_type any
offerings_data.integration_status.status string
offerings_data.integration_status.last_request_timestamp string (date-time)
offerings_data.integration_status.service_name string
offerings_data.google_calendar_is_public boolean
offerings_data.google_calendar_link string Get the Google Calendar link for an offering.
approval_limit string (decimal) The credit limit beyond which requests need to be approved by a local admin. If this is None, then no local approval is required. If this is set to 0, then all requests (including creating the project) need to be approved.
max_credit_limit string (decimal) The maximum credit limit for any projects created in this class. Any requests beyond this limit are automatically rejected. If this is None, then no maximum limit is set. If this is set to 0, then no projects can be created in this class.
allocation_units_mapping any The mapping of credits to allocation units, i.e. how many allocation units to award per credit allocated.
role_mapping any The mapping of role names from the remote portal to role information in this portal for users in projects created in this class.
role_mapping_data object (free-form) Serialize the role mapping dictionary returned by get_role_mapping()

Update ProjectTemplate object (full update)

Update ProjectTemplate object (full update)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
http \
  PUT \
  https://api.example.com/api/openportal-project-template/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-openportal-project-template" \
  offering="string-value" \
  provider="https://api.example.com/api/provider/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  portal="string-value" \
  customer="https://api.example.com/api/customer/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  offerings:='[]'

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.project_template_request import ProjectTemplateRequest # (1)
from waldur_api_client.api.openportal_project_template import openportal_project_template_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ProjectTemplateRequest(
    name="my-awesome-openportal-project-template",
    offering="string-value",
    provider="https://api.example.com/api/provider/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    portal="string-value",
    customer="https://api.example.com/api/customer/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    offerings=[]
)
response = openportal_project_template_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ProjectTemplateRequest
  2. API Source: openportal_project_template_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
import { openportalProjectTemplateUpdate } from 'waldur-js-client';

try {
  const response = await openportalProjectTemplateUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-openportal-project-template",
    "offering": "string-value",
    "provider": "https://api.example.com/api/provider/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "portal": "string-value",
    "customer": "https://api.example.com/api/customer/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "offerings": []
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
name string ✓
offering string ✓ The offering for which this template applies.
provider string (uri) ✓
portal string ✓
key string The key that is used to authenticate requests for this class.
customer string (uri) ✓
shortname string
offerings array of string (uri)s ✓
approval_limit string (decimal) The credit limit beyond which requests need to be approved by a local admin. If this is None, then no local approval is required. If this is set to 0, then all requests (including creating the project) need to be approved.
max_credit_limit string (decimal) The maximum credit limit for any projects created in this class. Any requests beyond this limit are automatically rejected. If this is None, then no maximum limit is set. If this is set to 0, then no projects can be created in this class.
allocation_units_mapping any The mapping of credits to allocation units, i.e. how many allocation units to award per credit allocated.
role_mapping any The mapping of role names from the remote portal to role information in this portal for users in projects created in this class.

200 -

Field Type Description
uuid string (uuid)
name string
offering string The offering for which this template applies.
provider string (uri)
provider_data any
portal string
key string The key that is used to authenticate requests for this class.
customer string (uri)
customer_data any
shortname string
offerings array of string (uri)s
offerings_data array of objects
offerings_data.url string (uri)
offerings_data.uuid string (uuid)
offerings_data.created string (date-time)
offerings_data.name string
offerings_data.slug string URL-friendly identifier. Only editable by staff users.
offerings_data.description string
offerings_data.full_description string
offerings_data.privacy_policy_link string (uri)
offerings_data.access_url string (uri) Publicly accessible offering access URL
offerings_data.endpoints array of objects
offerings_data.endpoints.uuid string (uuid)
offerings_data.endpoints.name string
offerings_data.endpoints.url string URL of the access endpoint
offerings_data.software_catalogs array of objects
offerings_data.software_catalogs.uuid string (uuid)
offerings_data.software_catalogs.catalog any
offerings_data.software_catalogs.enabled_cpu_family any List of enabled CPU families: ['x86_64', 'aarch64']
offerings_data.software_catalogs.enabled_cpu_microarchitectures any List of enabled CPU microarchitectures: ['generic', 'zen3']
offerings_data.software_catalogs.package_count integer
offerings_data.software_catalogs.partition any
offerings_data.partitions array of objects
offerings_data.partitions.uuid string (uuid)
offerings_data.partitions.partition_name string Name of the SLURM partition
offerings_data.partitions.cpu_bind integer Default task binding policy (SLURM cpu_bind)
offerings_data.partitions.def_cpu_per_gpu integer Default CPUs allocated per GPU
offerings_data.partitions.max_cpus_per_node integer Maximum allocated CPUs per node
offerings_data.partitions.max_cpus_per_socket integer Maximum allocated CPUs per socket
offerings_data.partitions.def_mem_per_cpu integer (int64) Default memory per CPU in MB
offerings_data.partitions.def_mem_per_gpu integer (int64) Default memory per GPU in MB
offerings_data.partitions.def_mem_per_node integer (int64) Default memory per node in MB
offerings_data.partitions.max_mem_per_cpu integer (int64) Maximum memory per CPU in MB
offerings_data.partitions.max_mem_per_node integer (int64) Maximum memory per node in MB
offerings_data.partitions.default_time integer Default time limit in minutes
offerings_data.partitions.max_time integer Maximum time limit in minutes
offerings_data.partitions.grace_time integer Preemption grace time in seconds
offerings_data.partitions.max_nodes integer Maximum nodes per job
offerings_data.partitions.min_nodes integer Minimum nodes per job
offerings_data.partitions.exclusive_topo boolean Exclusive topology access required
offerings_data.partitions.exclusive_user boolean Exclusive user access required
offerings_data.partitions.priority_tier integer Priority tier for scheduling and preemption
offerings_data.partitions.qos string Quality of Service (QOS) name
offerings_data.partitions.req_resv boolean Require reservation for job allocation
offerings_data.roles array of objects
offerings_data.roles.uuid string (uuid)
offerings_data.roles.name string
offerings_data.roles.url string (uri)
offerings_data.customer string (uri)
offerings_data.customer_uuid string (uuid)
offerings_data.customer_name string
offerings_data.project string (uri)
offerings_data.project_uuid string (uuid)
offerings_data.project_name string
offerings_data.category string (uri)
offerings_data.category_uuid string (uuid)
offerings_data.category_title string
offerings_data.attributes object (free-form)
offerings_data.options any
offerings_data.resource_options any
offerings_data.components array of objects
offerings_data.components.uuid string (uuid)
offerings_data.components.billing_type string
Enum: fixed, usage, limit, one, few
offerings_data.components.type string Unique internal name of the measured unit, for example floating_ip.
offerings_data.components.name string Display name for the measured unit, for example, Floating IP.
offerings_data.components.description string
offerings_data.components.measured_unit string Unit of measurement, for example, GB.
offerings_data.components.unit_factor integer The conversion factor from backend units to measured_unit
offerings_data.components.limit_period any
offerings_data.components.limit_amount integer
offerings_data.components.article_code string
offerings_data.components.max_value integer
offerings_data.components.min_value integer
offerings_data.components.max_available_limit integer
offerings_data.components.is_boolean boolean
offerings_data.components.default_limit integer
offerings_data.components.factor integer
offerings_data.components.is_builtin boolean
offerings_data.components.is_prepaid boolean
offerings_data.components.overage_component string (uuid)
offerings_data.components.min_prepaid_duration integer
offerings_data.components.max_prepaid_duration integer
offerings_data.plugin_options any
offerings_data.secret_options any
offerings_data.service_attributes object (free-form)
offerings_data.state any
offerings_data.vendor_details string
offerings_data.getting_started string
offerings_data.integration_guide string
offerings_data.thumbnail string (uri)
offerings_data.order_count integer
offerings_data.plans array of objects
offerings_data.plans.url string (uri)
offerings_data.plans.uuid string (uuid)
offerings_data.plans.name string
offerings_data.plans.description string
offerings_data.plans.article_code string
offerings_data.plans.max_amount integer Maximum number of plans that could be active. Plan is disabled when maximum amount is reached.
offerings_data.plans.archived boolean Forbids creation of new resources.
offerings_data.plans.is_active boolean
offerings_data.plans.unit_price string (decimal)
offerings_data.plans.unit string
Enum: month, quarter, half_month, day, hour, quantity
offerings_data.plans.init_price number (double)
offerings_data.plans.switch_price number (double)
offerings_data.plans.backend_id string
offerings_data.plans.organization_groups array of objects
offerings_data.plans.organization_groups.uuid string (uuid)
offerings_data.plans.organization_groups.url string (uri)
offerings_data.plans.organization_groups.name string
offerings_data.plans.organization_groups.parent_uuid string (uuid) UUID of the parent organization group
offerings_data.plans.organization_groups.parent_name string Name of the parent organization group
offerings_data.plans.organization_groups.parent string (uri)
offerings_data.plans.organization_groups.customers_count integer Number of customers in this organization group
offerings_data.plans.components array of objects
offerings_data.plans.components.type string Unique internal name of the measured unit, for example floating_ip.
offerings_data.plans.components.name string Display name for the measured unit, for example, Floating IP.
offerings_data.plans.components.measured_unit string Unit of measurement, for example, GB.
offerings_data.plans.components.amount integer
offerings_data.plans.components.price string (decimal)
offerings_data.plans.components.future_price string (decimal)
offerings_data.plans.components.discount_threshold integer Minimum amount to be eligible for discount.
offerings_data.plans.components.discount_rate integer Discount rate in percentage.
offerings_data.plans.prices object (free-form)
offerings_data.plans.future_prices object (free-form)
offerings_data.plans.quotas object (free-form)
offerings_data.plans.resources_count integer
offerings_data.plans.plan_type string
offerings_data.plans.minimal_price number (double)
offerings_data.screenshots array of objects
offerings_data.screenshots.name string
offerings_data.screenshots.uuid string (uuid)
offerings_data.screenshots.description string
offerings_data.screenshots.image string (uri)
offerings_data.screenshots.thumbnail string (uri)
offerings_data.screenshots.created string (date-time)
offerings_data.type string
offerings_data.shared boolean Accessible to all customers.
offerings_data.billable boolean Purchase and usage is invoiced.
offerings_data.scope string
offerings_data.scope_uuid string (uuid)
offerings_data.scope_name string (uuid)
offerings_data.scope_state any
offerings_data.scope_error_message string
offerings_data.files array of objects
offerings_data.files.name string
offerings_data.files.created string (date-time)
offerings_data.files.file string (uri)
offerings_data.quotas array of objects
offerings_data.quotas.name string
offerings_data.quotas.usage integer
offerings_data.quotas.limit integer
offerings_data.paused_reason string
offerings_data.datacite_doi string
offerings_data.citation_count integer Number of citations of a DOI
offerings_data.latitude number (double)
offerings_data.longitude number (double)
offerings_data.country any Country code (ISO 3166-1 alpha-2)
offerings_data.backend_id string
offerings_data.backend_id_rules any Validation rules for resource backend_id: format regex and uniqueness scope.
offerings_data.organization_groups array of objects
offerings_data.organization_groups.uuid string (uuid)
offerings_data.organization_groups.url string (uri)
offerings_data.organization_groups.name string
offerings_data.organization_groups.parent_uuid string (uuid) UUID of the parent organization group
offerings_data.organization_groups.parent_name string Name of the parent organization group
offerings_data.organization_groups.parent string (uri)
offerings_data.organization_groups.customers_count integer Number of customers in this organization group
offerings_data.tags array of objects
offerings_data.tags.uuid string (uuid)
offerings_data.tags.name string
offerings_data.image string (uri)
offerings_data.total_customers integer
offerings_data.total_cost integer
offerings_data.total_cost_estimated integer
offerings_data.parent_description string
offerings_data.parent_uuid string (uuid)
offerings_data.parent_name string
offerings_data.backend_metadata any
offerings_data.has_compliance_requirements boolean
offerings_data.billing_type_classification string Classify offering components by billing type. Returns 'limit_only', 'usage_only', or 'mixed'.
offerings_data.compliance_checklist string (uri)
offerings_data.integration_status array of objects
offerings_data.integration_status.agent_type any
offerings_data.integration_status.status string
offerings_data.integration_status.last_request_timestamp string (date-time)
offerings_data.integration_status.service_name string
offerings_data.google_calendar_is_public boolean
offerings_data.google_calendar_link string Get the Google Calendar link for an offering.
approval_limit string (decimal) The credit limit beyond which requests need to be approved by a local admin. If this is None, then no local approval is required. If this is set to 0, then all requests (including creating the project) need to be approved.
max_credit_limit string (decimal) The maximum credit limit for any projects created in this class. Any requests beyond this limit are automatically rejected. If this is None, then no maximum limit is set. If this is set to 0, then no projects can be created in this class.
allocation_units_mapping any The mapping of credits to allocation units, i.e. how many allocation units to award per credit allocated.
role_mapping any The mapping of role names from the remote portal to role information in this portal for users in projects created in this class.
role_mapping_data object (free-form) Serialize the role mapping dictionary returned by get_role_mapping()

Partially update ProjectTemplate object

Partially update ProjectTemplate object

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/openportal-project-template/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_project_template_request import PatchedProjectTemplateRequest # (1)
from waldur_api_client.api.openportal_project_template import openportal_project_template_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedProjectTemplateRequest()
response = openportal_project_template_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedProjectTemplateRequest
  2. API Source: openportal_project_template_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openportalProjectTemplatePartialUpdate } from 'waldur-js-client';

try {
  const response = await openportalProjectTemplatePartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
name string
offering string The offering for which this template applies.
provider string (uri)
portal string
key string The key that is used to authenticate requests for this class.
customer string (uri)
shortname string
offerings array of string (uri)s
approval_limit string (decimal) The credit limit beyond which requests need to be approved by a local admin. If this is None, then no local approval is required. If this is set to 0, then all requests (including creating the project) need to be approved.
max_credit_limit string (decimal) The maximum credit limit for any projects created in this class. Any requests beyond this limit are automatically rejected. If this is None, then no maximum limit is set. If this is set to 0, then no projects can be created in this class.
allocation_units_mapping any The mapping of credits to allocation units, i.e. how many allocation units to award per credit allocated.
role_mapping any The mapping of role names from the remote portal to role information in this portal for users in projects created in this class.

200 -

Field Type Description
uuid string (uuid)
name string
offering string The offering for which this template applies.
provider string (uri)
provider_data any
portal string
key string The key that is used to authenticate requests for this class.
customer string (uri)
customer_data any
shortname string
offerings array of string (uri)s
offerings_data array of objects
offerings_data.url string (uri)
offerings_data.uuid string (uuid)
offerings_data.created string (date-time)
offerings_data.name string
offerings_data.slug string URL-friendly identifier. Only editable by staff users.
offerings_data.description string
offerings_data.full_description string
offerings_data.privacy_policy_link string (uri)
offerings_data.access_url string (uri) Publicly accessible offering access URL
offerings_data.endpoints array of objects
offerings_data.endpoints.uuid string (uuid)
offerings_data.endpoints.name string
offerings_data.endpoints.url string URL of the access endpoint
offerings_data.software_catalogs array of objects
offerings_data.software_catalogs.uuid string (uuid)
offerings_data.software_catalogs.catalog any
offerings_data.software_catalogs.enabled_cpu_family any List of enabled CPU families: ['x86_64', 'aarch64']
offerings_data.software_catalogs.enabled_cpu_microarchitectures any List of enabled CPU microarchitectures: ['generic', 'zen3']
offerings_data.software_catalogs.package_count integer
offerings_data.software_catalogs.partition any
offerings_data.partitions array of objects
offerings_data.partitions.uuid string (uuid)
offerings_data.partitions.partition_name string Name of the SLURM partition
offerings_data.partitions.cpu_bind integer Default task binding policy (SLURM cpu_bind)
offerings_data.partitions.def_cpu_per_gpu integer Default CPUs allocated per GPU
offerings_data.partitions.max_cpus_per_node integer Maximum allocated CPUs per node
offerings_data.partitions.max_cpus_per_socket integer Maximum allocated CPUs per socket
offerings_data.partitions.def_mem_per_cpu integer (int64) Default memory per CPU in MB
offerings_data.partitions.def_mem_per_gpu integer (int64) Default memory per GPU in MB
offerings_data.partitions.def_mem_per_node integer (int64) Default memory per node in MB
offerings_data.partitions.max_mem_per_cpu integer (int64) Maximum memory per CPU in MB
offerings_data.partitions.max_mem_per_node integer (int64) Maximum memory per node in MB
offerings_data.partitions.default_time integer Default time limit in minutes
offerings_data.partitions.max_time integer Maximum time limit in minutes
offerings_data.partitions.grace_time integer Preemption grace time in seconds
offerings_data.partitions.max_nodes integer Maximum nodes per job
offerings_data.partitions.min_nodes integer Minimum nodes per job
offerings_data.partitions.exclusive_topo boolean Exclusive topology access required
offerings_data.partitions.exclusive_user boolean Exclusive user access required
offerings_data.partitions.priority_tier integer Priority tier for scheduling and preemption
offerings_data.partitions.qos string Quality of Service (QOS) name
offerings_data.partitions.req_resv boolean Require reservation for job allocation
offerings_data.roles array of objects
offerings_data.roles.uuid string (uuid)
offerings_data.roles.name string
offerings_data.roles.url string (uri)
offerings_data.customer string (uri)
offerings_data.customer_uuid string (uuid)
offerings_data.customer_name string
offerings_data.project string (uri)
offerings_data.project_uuid string (uuid)
offerings_data.project_name string
offerings_data.category string (uri)
offerings_data.category_uuid string (uuid)
offerings_data.category_title string
offerings_data.attributes object (free-form)
offerings_data.options any
offerings_data.resource_options any
offerings_data.components array of objects
offerings_data.components.uuid string (uuid)
offerings_data.components.billing_type string
Enum: fixed, usage, limit, one, few
offerings_data.components.type string Unique internal name of the measured unit, for example floating_ip.
offerings_data.components.name string Display name for the measured unit, for example, Floating IP.
offerings_data.components.description string
offerings_data.components.measured_unit string Unit of measurement, for example, GB.
offerings_data.components.unit_factor integer The conversion factor from backend units to measured_unit
offerings_data.components.limit_period any
offerings_data.components.limit_amount integer
offerings_data.components.article_code string
offerings_data.components.max_value integer
offerings_data.components.min_value integer
offerings_data.components.max_available_limit integer
offerings_data.components.is_boolean boolean
offerings_data.components.default_limit integer
offerings_data.components.factor integer
offerings_data.components.is_builtin boolean
offerings_data.components.is_prepaid boolean
offerings_data.components.overage_component string (uuid)
offerings_data.components.min_prepaid_duration integer
offerings_data.components.max_prepaid_duration integer
offerings_data.plugin_options any
offerings_data.secret_options any
offerings_data.service_attributes object (free-form)
offerings_data.state any
offerings_data.vendor_details string
offerings_data.getting_started string
offerings_data.integration_guide string
offerings_data.thumbnail string (uri)
offerings_data.order_count integer
offerings_data.plans array of objects
offerings_data.plans.url string (uri)
offerings_data.plans.uuid string (uuid)
offerings_data.plans.name string
offerings_data.plans.description string
offerings_data.plans.article_code string
offerings_data.plans.max_amount integer Maximum number of plans that could be active. Plan is disabled when maximum amount is reached.
offerings_data.plans.archived boolean Forbids creation of new resources.
offerings_data.plans.is_active boolean
offerings_data.plans.unit_price string (decimal)
offerings_data.plans.unit string
Enum: month, quarter, half_month, day, hour, quantity
offerings_data.plans.init_price number (double)
offerings_data.plans.switch_price number (double)
offerings_data.plans.backend_id string
offerings_data.plans.organization_groups array of objects
offerings_data.plans.organization_groups.uuid string (uuid)
offerings_data.plans.organization_groups.url string (uri)
offerings_data.plans.organization_groups.name string
offerings_data.plans.organization_groups.parent_uuid string (uuid) UUID of the parent organization group
offerings_data.plans.organization_groups.parent_name string Name of the parent organization group
offerings_data.plans.organization_groups.parent string (uri)
offerings_data.plans.organization_groups.customers_count integer Number of customers in this organization group
offerings_data.plans.components array of objects
offerings_data.plans.components.type string Unique internal name of the measured unit, for example floating_ip.
offerings_data.plans.components.name string Display name for the measured unit, for example, Floating IP.
offerings_data.plans.components.measured_unit string Unit of measurement, for example, GB.
offerings_data.plans.components.amount integer
offerings_data.plans.components.price string (decimal)
offerings_data.plans.components.future_price string (decimal)
offerings_data.plans.components.discount_threshold integer Minimum amount to be eligible for discount.
offerings_data.plans.components.discount_rate integer Discount rate in percentage.
offerings_data.plans.prices object (free-form)
offerings_data.plans.future_prices object (free-form)
offerings_data.plans.quotas object (free-form)
offerings_data.plans.resources_count integer
offerings_data.plans.plan_type string
offerings_data.plans.minimal_price number (double)
offerings_data.screenshots array of objects
offerings_data.screenshots.name string
offerings_data.screenshots.uuid string (uuid)
offerings_data.screenshots.description string
offerings_data.screenshots.image string (uri)
offerings_data.screenshots.thumbnail string (uri)
offerings_data.screenshots.created string (date-time)
offerings_data.type string
offerings_data.shared boolean Accessible to all customers.
offerings_data.billable boolean Purchase and usage is invoiced.
offerings_data.scope string
offerings_data.scope_uuid string (uuid)
offerings_data.scope_name string (uuid)
offerings_data.scope_state any
offerings_data.scope_error_message string
offerings_data.files array of objects
offerings_data.files.name string
offerings_data.files.created string (date-time)
offerings_data.files.file string (uri)
offerings_data.quotas array of objects
offerings_data.quotas.name string
offerings_data.quotas.usage integer
offerings_data.quotas.limit integer
offerings_data.paused_reason string
offerings_data.datacite_doi string
offerings_data.citation_count integer Number of citations of a DOI
offerings_data.latitude number (double)
offerings_data.longitude number (double)
offerings_data.country any Country code (ISO 3166-1 alpha-2)
offerings_data.backend_id string
offerings_data.backend_id_rules any Validation rules for resource backend_id: format regex and uniqueness scope.
offerings_data.organization_groups array of objects
offerings_data.organization_groups.uuid string (uuid)
offerings_data.organization_groups.url string (uri)
offerings_data.organization_groups.name string
offerings_data.organization_groups.parent_uuid string (uuid) UUID of the parent organization group
offerings_data.organization_groups.parent_name string Name of the parent organization group
offerings_data.organization_groups.parent string (uri)
offerings_data.organization_groups.customers_count integer Number of customers in this organization group
offerings_data.tags array of objects
offerings_data.tags.uuid string (uuid)
offerings_data.tags.name string
offerings_data.image string (uri)
offerings_data.total_customers integer
offerings_data.total_cost integer
offerings_data.total_cost_estimated integer
offerings_data.parent_description string
offerings_data.parent_uuid string (uuid)
offerings_data.parent_name string
offerings_data.backend_metadata any
offerings_data.has_compliance_requirements boolean
offerings_data.billing_type_classification string Classify offering components by billing type. Returns 'limit_only', 'usage_only', or 'mixed'.
offerings_data.compliance_checklist string (uri)
offerings_data.integration_status array of objects
offerings_data.integration_status.agent_type any
offerings_data.integration_status.status string
offerings_data.integration_status.last_request_timestamp string (date-time)
offerings_data.integration_status.service_name string
offerings_data.google_calendar_is_public boolean
offerings_data.google_calendar_link string Get the Google Calendar link for an offering.
approval_limit string (decimal) The credit limit beyond which requests need to be approved by a local admin. If this is None, then no local approval is required. If this is set to 0, then all requests (including creating the project) need to be approved.
max_credit_limit string (decimal) The maximum credit limit for any projects created in this class. Any requests beyond this limit are automatically rejected. If this is None, then no maximum limit is set. If this is set to 0, then no projects can be created in this class.
allocation_units_mapping any The mapping of credits to allocation units, i.e. how many allocation units to award per credit allocated.
role_mapping any The mapping of role names from the remote portal to role information in this portal for users in projects created in this class.
role_mapping_data object (free-form) Serialize the role mapping dictionary returned by get_role_mapping()

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/openportal-project-template/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openportal_project_template import openportal_project_template_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openportal_project_template_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openportal_project_template_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openportalProjectTemplateDestroy } from 'waldur-js-client';

try {
  const response = await openportalProjectTemplateDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Other Actions

Delete ProjectTemplate object

Delete ProjectTemplate object

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/openportal-project-template/a1b2c3d4-e5f6-7890-abcd-ef1234567890/delete/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openportal_project_template import openportal_project_template_delete_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openportal_project_template_delete_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openportal_project_template_delete_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openportalProjectTemplateDeleteDestroy } from 'waldur-js-client';

try {
  const response = await openportalProjectTemplateDeleteDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Openportal Projectinfo

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/openportal-projectinfo/ List Openportal Projectinfo
GET /api/openportal-projectinfo/{project}/ Retrieve
POST /api/openportal-projectinfo/ Create
PUT /api/openportal-projectinfo/{project}/ Update
PATCH /api/openportal-projectinfo/{project}/ Partial Update
DELETE /api/openportal-projectinfo/{project}/ Delete
Other Actions
PUT /api/openportal-projectinfo/{project}/set_allowed_destinations/ Set allowed destinations
PUT /api/openportal-projectinfo/{project}/set_shortname/ Set shortname

Core CRUD

List Openportal Projectinfo

1
2
3
4
http \
  GET \
  https://api.example.com/api/openportal-projectinfo/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openportal_projectinfo import openportal_projectinfo_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openportal_projectinfo_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: openportal_projectinfo_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { openportalProjectinfoList } from 'waldur-js-client';

try {
  const response = await openportalProjectinfoList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
project string (uri)
project_uuid string (uuid)

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
project string (uri)
shortname string A short, unique name for the project. It will be used to form the local username of any users in the project on any systems. Should only contain lower-case letters and digits and must start with a letter.
allowed_destinations string A comma-separated list of allowable destinations of instances that can be attached to this project. For example, a project may only allow 'brics.aip1.*', meaning that only instances that start with 'brics.aip1.' can be attached to this project.

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/openportal-projectinfo/123/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openportal_projectinfo import openportal_projectinfo_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openportal_projectinfo_retrieve.sync(
    project=123,
    client=client
)

print(response)
  1. API Source: openportal_projectinfo_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openportalProjectinfoRetrieve } from 'waldur-js-client';

try {
  const response = await openportalProjectinfoRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "project": 123
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
project integer (uri) ✓

200 -

Field Type Description
project string (uri)
shortname string A short, unique name for the project. It will be used to form the local username of any users in the project on any systems. Should only contain lower-case letters and digits and must start with a letter.
allowed_destinations string A comma-separated list of allowable destinations of instances that can be attached to this project. For example, a project may only allow 'brics.aip1.*', meaning that only instances that start with 'brics.aip1.' can be attached to this project.

Create

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/openportal-projectinfo/ \
  Authorization:"Token YOUR_API_TOKEN" \
  project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.project_info_request import ProjectInfoRequest # (1)
from waldur_api_client.api.openportal_projectinfo import openportal_projectinfo_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ProjectInfoRequest(
    project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = openportal_projectinfo_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ProjectInfoRequest
  2. API Source: openportal_projectinfo_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openportalProjectinfoCreate } from 'waldur-js-client';

try {
  const response = await openportalProjectinfoCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "project": "https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
project string (uri) ✓
shortname string A short, unique name for the project. It will be used to form the local username of any users in the project on any systems. Should only contain lower-case letters and digits and must start with a letter.
allowed_destinations string A comma-separated list of allowable destinations of instances that can be attached to this project. For example, a project may only allow 'brics.aip1.*', meaning that only instances that start with 'brics.aip1.' can be attached to this project.

201 -

Field Type Description
project string (uri)
shortname string A short, unique name for the project. It will be used to form the local username of any users in the project on any systems. Should only contain lower-case letters and digits and must start with a letter.
allowed_destinations string A comma-separated list of allowable destinations of instances that can be attached to this project. For example, a project may only allow 'brics.aip1.*', meaning that only instances that start with 'brics.aip1.' can be attached to this project.

Update

1
2
3
4
5
http \
  PUT \
  https://api.example.com/api/openportal-projectinfo/123/ \
  Authorization:"Token YOUR_API_TOKEN" \
  project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.project_info_request import ProjectInfoRequest # (1)
from waldur_api_client.api.openportal_projectinfo import openportal_projectinfo_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ProjectInfoRequest(
    project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = openportal_projectinfo_update.sync(
    project=123,
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ProjectInfoRequest
  2. API Source: openportal_projectinfo_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { openportalProjectinfoUpdate } from 'waldur-js-client';

try {
  const response = await openportalProjectinfoUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "project": 123
  },
  body: {
    "project": "https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
project integer (uri) ✓
Field Type Required Description
project string (uri) ✓
shortname string A short, unique name for the project. It will be used to form the local username of any users in the project on any systems. Should only contain lower-case letters and digits and must start with a letter.
allowed_destinations string A comma-separated list of allowable destinations of instances that can be attached to this project. For example, a project may only allow 'brics.aip1.*', meaning that only instances that start with 'brics.aip1.' can be attached to this project.

200 -

Field Type Description
project string (uri)
shortname string A short, unique name for the project. It will be used to form the local username of any users in the project on any systems. Should only contain lower-case letters and digits and must start with a letter.
allowed_destinations string A comma-separated list of allowable destinations of instances that can be attached to this project. For example, a project may only allow 'brics.aip1.*', meaning that only instances that start with 'brics.aip1.' can be attached to this project.

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/openportal-projectinfo/123/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_project_info_request import PatchedProjectInfoRequest # (1)
from waldur_api_client.api.openportal_projectinfo import openportal_projectinfo_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedProjectInfoRequest()
response = openportal_projectinfo_partial_update.sync(
    project=123,
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedProjectInfoRequest
  2. API Source: openportal_projectinfo_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openportalProjectinfoPartialUpdate } from 'waldur-js-client';

try {
  const response = await openportalProjectinfoPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "project": 123
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
project integer (uri) ✓
Field Type Required Description
project string (uri)
shortname string A short, unique name for the project. It will be used to form the local username of any users in the project on any systems. Should only contain lower-case letters and digits and must start with a letter.
allowed_destinations string A comma-separated list of allowable destinations of instances that can be attached to this project. For example, a project may only allow 'brics.aip1.*', meaning that only instances that start with 'brics.aip1.' can be attached to this project.

200 -

Field Type Description
project string (uri)
shortname string A short, unique name for the project. It will be used to form the local username of any users in the project on any systems. Should only contain lower-case letters and digits and must start with a letter.
allowed_destinations string A comma-separated list of allowable destinations of instances that can be attached to this project. For example, a project may only allow 'brics.aip1.*', meaning that only instances that start with 'brics.aip1.' can be attached to this project.

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/openportal-projectinfo/123/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openportal_projectinfo import openportal_projectinfo_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openportal_projectinfo_destroy.sync(
    project=123,
    client=client
)

print(response)
  1. API Source: openportal_projectinfo_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openportalProjectinfoDestroy } from 'waldur-js-client';

try {
  const response = await openportalProjectinfoDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "project": 123
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
project integer (uri) ✓

204 - No response body

Other Actions

Set allowed destinations

1
2
3
4
5
http \
  PUT \
  https://api.example.com/api/openportal-projectinfo/123/set_allowed_destinations/ \
  Authorization:"Token YOUR_API_TOKEN" \
  project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.project_info_request import ProjectInfoRequest # (1)
from waldur_api_client.api.openportal_projectinfo import openportal_projectinfo_set_allowed_destinations_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ProjectInfoRequest(
    project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = openportal_projectinfo_set_allowed_destinations_update.sync(
    project=123,
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ProjectInfoRequest
  2. API Source: openportal_projectinfo_set_allowed_destinations_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { openportalProjectinfoSetAllowedDestinationsUpdate } from 'waldur-js-client';

try {
  const response = await openportalProjectinfoSetAllowedDestinationsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "project": 123
  },
  body: {
    "project": "https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
project integer (uri) ✓
Field Type Required Description
project string (uri) ✓
shortname string A short, unique name for the project. It will be used to form the local username of any users in the project on any systems. Should only contain lower-case letters and digits and must start with a letter.
allowed_destinations string A comma-separated list of allowable destinations of instances that can be attached to this project. For example, a project may only allow 'brics.aip1.*', meaning that only instances that start with 'brics.aip1.' can be attached to this project.

200 -

Field Type Description
project string (uri)
shortname string A short, unique name for the project. It will be used to form the local username of any users in the project on any systems. Should only contain lower-case letters and digits and must start with a letter.
allowed_destinations string A comma-separated list of allowable destinations of instances that can be attached to this project. For example, a project may only allow 'brics.aip1.*', meaning that only instances that start with 'brics.aip1.' can be attached to this project.

Set shortname

1
2
3
4
5
http \
  PUT \
  https://api.example.com/api/openportal-projectinfo/123/set_shortname/ \
  Authorization:"Token YOUR_API_TOKEN" \
  project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.project_info_request import ProjectInfoRequest # (1)
from waldur_api_client.api.openportal_projectinfo import openportal_projectinfo_set_shortname_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ProjectInfoRequest(
    project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = openportal_projectinfo_set_shortname_update.sync(
    project=123,
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ProjectInfoRequest
  2. API Source: openportal_projectinfo_set_shortname_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { openportalProjectinfoSetShortnameUpdate } from 'waldur-js-client';

try {
  const response = await openportalProjectinfoSetShortnameUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "project": 123
  },
  body: {
    "project": "https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
project integer (uri) ✓
Field Type Required Description
project string (uri) ✓
shortname string A short, unique name for the project. It will be used to form the local username of any users in the project on any systems. Should only contain lower-case letters and digits and must start with a letter.
allowed_destinations string A comma-separated list of allowable destinations of instances that can be attached to this project. For example, a project may only allow 'brics.aip1.*', meaning that only instances that start with 'brics.aip1.' can be attached to this project.

200 -

Field Type Description
project string (uri)
shortname string A short, unique name for the project. It will be used to form the local username of any users in the project on any systems. Should only contain lower-case letters and digits and must start with a letter.
allowed_destinations string A comma-separated list of allowable destinations of instances that can be attached to this project. For example, a project may only allow 'brics.aip1.*', meaning that only instances that start with 'brics.aip1.' can be attached to this project.

Openportal Remote Allocations

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/openportal-remote-allocations/ List Openportal Remote Allocations
GET /api/openportal-remote-allocations/{uuid}/ Retrieve
POST /api/openportal-remote-allocations/ Create
POST /api/openportal-remote-allocations/{uuid}/pull/ Synchronize resource state
POST /api/openportal-remote-allocations/{uuid}/unlink/ Unlink resource
PUT /api/openportal-remote-allocations/{uuid}/ Update
PATCH /api/openportal-remote-allocations/{uuid}/ Partial Update
DELETE /api/openportal-remote-allocations/{uuid}/ Delete
Other Actions
POST /api/openportal-remote-allocations/{uuid}/set_erred/ Mark resource as ERRED
POST /api/openportal-remote-allocations/{uuid}/set_limits/ Set limits
POST /api/openportal-remote-allocations/{uuid}/set_ok/ Mark resource as OK

Core CRUD

List Openportal Remote Allocations

1
2
3
4
http \
  GET \
  https://api.example.com/api/openportal-remote-allocations/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.core_states import CoreStates # (1)
from waldur_api_client.models.remote_allocation_field_enum import RemoteAllocationFieldEnum # (2)
from waldur_api_client.api.openportal_remote_allocations import openportal_remote_allocations_list # (3)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openportal_remote_allocations_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: CoreStates
  2. Model Source: RemoteAllocationFieldEnum
  3. API Source: openportal_remote_allocations_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { openportalRemoteAllocationsList } from 'waldur-js-client';

try {
  const response = await openportalRemoteAllocationsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
backend_id string Backend ID
can_manage boolean Can manage
customer string (uuid) Customer UUID
customer_abbreviation string Customer abbreviation
customer_name string Customer name
customer_native_name string Customer native name
customer_uuid string (uuid) Customer UUID
description string Description
external_ip string External IP
field array
is_active boolean
name string Name
name_exact string Name (exact)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
project string (uuid) Project UUID
project_name string Project name
project_uuid string (uuid) Project UUID
service_settings_name string Service settings name
service_settings_uuid string (uuid) Service settings UUID
state array State
uuid string (uuid) UUID

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
node_limit integer (int64)
remote_project_identifier string The identifier of the project in the remote OpenPortal instance.
node_usage string (decimal)
is_active boolean
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/openportal-remote-allocations/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.remote_allocation_field_enum import RemoteAllocationFieldEnum # (1)
from waldur_api_client.api.openportal_remote_allocations import openportal_remote_allocations_retrieve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openportal_remote_allocations_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. Model Source: RemoteAllocationFieldEnum
  2. API Source: openportal_remote_allocations_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openportalRemoteAllocationsRetrieve } from 'waldur-js-client';

try {
  const response = await openportalRemoteAllocationsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type
field array

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
node_limit integer (int64)
remote_project_identifier string The identifier of the project in the remote OpenPortal instance.
node_usage string (decimal)
is_active boolean
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Create

1
2
3
4
5
6
7
http \
  POST \
  https://api.example.com/api/openportal-remote-allocations/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-openportal-remote-allocation" \
  service_settings="https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.remote_allocation_request import RemoteAllocationRequest # (1)
from waldur_api_client.api.openportal_remote_allocations import openportal_remote_allocations_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = RemoteAllocationRequest(
    name="my-awesome-openportal-remote-allocation",
    service_settings="https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = openportal_remote_allocations_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: RemoteAllocationRequest
  2. API Source: openportal_remote_allocations_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
import { openportalRemoteAllocationsCreate } from 'waldur-js-client';

try {
  const response = await openportalRemoteAllocationsCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "name": "my-awesome-openportal-remote-allocation",
    "service_settings": "https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "project": "https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
name string ✓
description string
service_settings string (uri) ✓
project string (uri) ✓
node_limit integer (int64)
remote_project_identifier string The identifier of the project in the remote OpenPortal instance.

201 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
node_limit integer (int64)
remote_project_identifier string The identifier of the project in the remote OpenPortal instance.
node_usage string (decimal)
is_active boolean
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Synchronize resource state

Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.

1
2
3
4
http \
  POST \
  https://api.example.com/api/openportal-remote-allocations/a1b2c3d4-e5f6-7890-abcd-ef1234567890/pull/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openportal_remote_allocations import openportal_remote_allocations_pull # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openportal_remote_allocations_pull.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openportal_remote_allocations_pull
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openportalRemoteAllocationsPull } from 'waldur-js-client';

try {
  const response = await openportalRemoteAllocationsPull({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

202 -

Field Type
detail string

409 -

Field Type
detail string

Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state.

1
2
3
4
http \
  POST \
  https://api.example.com/api/openportal-remote-allocations/a1b2c3d4-e5f6-7890-abcd-ef1234567890/unlink/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openportal_remote_allocations import openportal_remote_allocations_unlink # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openportal_remote_allocations_unlink.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openportal_remote_allocations_unlink
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openportalRemoteAllocationsUnlink } from 'waldur-js-client';

try {
  const response = await openportalRemoteAllocationsUnlink({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Update

1
2
3
4
5
6
7
http \
  PUT \
  https://api.example.com/api/openportal-remote-allocations/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-openportal-remote-allocation" \
  service_settings="https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.remote_allocation_request import RemoteAllocationRequest # (1)
from waldur_api_client.api.openportal_remote_allocations import openportal_remote_allocations_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = RemoteAllocationRequest(
    name="my-awesome-openportal-remote-allocation",
    service_settings="https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = openportal_remote_allocations_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: RemoteAllocationRequest
  2. API Source: openportal_remote_allocations_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
import { openportalRemoteAllocationsUpdate } from 'waldur-js-client';

try {
  const response = await openportalRemoteAllocationsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-openportal-remote-allocation",
    "service_settings": "https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "project": "https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
name string ✓
description string
service_settings string (uri) ✓
project string (uri) ✓
node_limit integer (int64)
remote_project_identifier string The identifier of the project in the remote OpenPortal instance.

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
node_limit integer (int64)
remote_project_identifier string The identifier of the project in the remote OpenPortal instance.
node_usage string (decimal)
is_active boolean
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/openportal-remote-allocations/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_remote_allocation_request import PatchedRemoteAllocationRequest # (1)
from waldur_api_client.api.openportal_remote_allocations import openportal_remote_allocations_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedRemoteAllocationRequest()
response = openportal_remote_allocations_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedRemoteAllocationRequest
  2. API Source: openportal_remote_allocations_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openportalRemoteAllocationsPartialUpdate } from 'waldur-js-client';

try {
  const response = await openportalRemoteAllocationsPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
name string
description string
node_limit integer (int64)
remote_project_identifier string The identifier of the project in the remote OpenPortal instance.

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
node_limit integer (int64)
remote_project_identifier string The identifier of the project in the remote OpenPortal instance.
node_usage string (decimal)
is_active boolean
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/openportal-remote-allocations/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openportal_remote_allocations import openportal_remote_allocations_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openportal_remote_allocations_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openportal_remote_allocations_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openportalRemoteAllocationsDestroy } from 'waldur-js-client';

try {
  const response = await openportalRemoteAllocationsDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Other Actions

Mark resource as ERRED

Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.

1
2
3
4
http \
  POST \
  https://api.example.com/api/openportal-remote-allocations/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_erred/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.set_erred_request import SetErredRequest # (1)
from waldur_api_client.api.openportal_remote_allocations import openportal_remote_allocations_set_erred # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = SetErredRequest()
response = openportal_remote_allocations_set_erred.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: SetErredRequest
  2. API Source: openportal_remote_allocations_set_erred
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openportalRemoteAllocationsSetErred } from 'waldur-js-client';

try {
  const response = await openportalRemoteAllocationsSetErred({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
error_message string
error_traceback string

200 -

Field Type
detail string

Set limits

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/openportal-remote-allocations/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_limits/ \
  Authorization:"Token YOUR_API_TOKEN" \
  node_limit=123

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.remote_allocation_set_limits_request import RemoteAllocationSetLimitsRequest # (1)
from waldur_api_client.api.openportal_remote_allocations import openportal_remote_allocations_set_limits # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = RemoteAllocationSetLimitsRequest(
    node_limit=123
)
response = openportal_remote_allocations_set_limits.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: RemoteAllocationSetLimitsRequest
  2. API Source: openportal_remote_allocations_set_limits
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { openportalRemoteAllocationsSetLimits } from 'waldur-js-client';

try {
  const response = await openportalRemoteAllocationsSetLimits({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "node_limit": 123
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
node_limit integer ✓

200 -

Field Type
node_limit integer

Mark resource as OK

Manually transition the resource to OK state and clear error fields. Staff-only operation.

1
2
3
4
http \
  POST \
  https://api.example.com/api/openportal-remote-allocations/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_ok/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openportal_remote_allocations import openportal_remote_allocations_set_ok # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openportal_remote_allocations_set_ok.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openportal_remote_allocations_set_ok
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openportalRemoteAllocationsSetOk } from 'waldur-js-client';

try {
  const response = await openportalRemoteAllocationsSetOk({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
detail string

Openportal Remote Associations

Operations Summary

Method Endpoint Description
GET /api/openportal-remote-associations/ List Openportal Remote Associations
GET /api/openportal-remote-associations/{uuid}/ Retrieve

List Openportal Remote Associations

1
2
3
4
http \
  GET \
  https://api.example.com/api/openportal-remote-associations/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openportal_remote_associations import openportal_remote_associations_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openportal_remote_associations_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: openportal_remote_associations_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { openportalRemoteAssociationsList } from 'waldur-js-client';

try {
  const response = await openportalRemoteAssociationsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
allocation string (uri)
allocation_uuid string (uuid)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
uuid string (uuid)
allocation string (uri)

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/openportal-remote-associations/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openportal_remote_associations import openportal_remote_associations_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openportal_remote_associations_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openportal_remote_associations_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openportalRemoteAssociationsRetrieve } from 'waldur-js-client';

try {
  const response = await openportalRemoteAssociationsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
uuid string (uuid)
allocation string (uri)

Openportal Unmanaged Projects

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/openportal-unmanaged-projects/ List projects
GET /api/openportal-unmanaged-projects/{uuid}/ Retrieve project details
POST /api/openportal-unmanaged-projects/ Create a new project
PUT /api/openportal-unmanaged-projects/{uuid}/ Update project details
PATCH /api/openportal-unmanaged-projects/{uuid}/ Partially update project details
DELETE /api/openportal-unmanaged-projects/{uuid}/ Delete a project
Permissions & Users
GET /api/openportal-unmanaged-projects/{uuid}/list_users/ List users and their roles in a scope
POST /api/openportal-unmanaged-projects/{uuid}/add_user/ Grant a role to a user
POST /api/openportal-unmanaged-projects/{uuid}/delete_user/ Revoke a role from a user
POST /api/openportal-unmanaged-projects/{uuid}/update_user/ Update a user's role expiration
Other Actions
GET /api/openportal-unmanaged-projects/{uuid}/checklist/ Get checklist with questions and existing answers
GET /api/openportal-unmanaged-projects/checklist-template/ Get checklist template for creating new objects
GET /api/openportal-unmanaged-projects/{uuid}/completion_status/ Get checklist completion status
GET /api/openportal-unmanaged-projects/{uuid}/stats/ Get project resource usage statistics
POST /api/openportal-unmanaged-projects/{uuid}/move_project/ Move project to another customer
POST /api/openportal-unmanaged-projects/{uuid}/recover/ Recover a soft-deleted project
POST /api/openportal-unmanaged-projects/{uuid}/submit_answers/ Submit checklist answers

Core CRUD

List projects

Retrieve a list of projects. The list is filtered based on the user's permissions. By default, only active projects are shown.

1
2
3
4
http \
  GET \
  https://api.example.com/api/openportal-unmanaged-projects/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.marketplace_provider_customer_project_o_enum import MarketplaceProviderCustomerProjectOEnum # (1)
from waldur_api_client.models.project_field_enum import ProjectFieldEnum # (2)
from waldur_api_client.api.openportal_unmanaged_projects import openportal_unmanaged_projects_list # (3)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openportal_unmanaged_projects_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: MarketplaceProviderCustomerProjectOEnum
  2. Model Source: ProjectFieldEnum
  3. API Source: openportal_unmanaged_projects_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { openportalUnmanagedProjectsList } from 'waldur-js-client';

try {
  const response = await openportalUnmanagedProjectsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
accounting_is_running boolean Filter by whether accounting is running.
backend_id string
can_admin boolean Return a list of projects where current user is admin.
can_manage boolean Return a list of projects where current user is manager or a customer owner.
conceal_finished_projects boolean Conceal finished projects
created string (date-time) Created after
customer array Multiple values may be separated by commas.
customer_abbreviation string Customer abbreviation
customer_name string Customer name
customer_native_name string Customer native name
description string Description
field array
include_terminated boolean Include soft-deleted (terminated) projects. Only available to staff and support users, or users with organizational roles who can see their terminated projects.
is_removed boolean Is removed
modified string (date-time) Modified after
name string Name
name_exact string Name (exact)
o array Ordering
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
query string Filter by name, slug, UUID, backend ID or resource effective ID
slug string Slug
user_uuid string (uuid) Filter by user UUID.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
name string
slug string URL-friendly identifier. Only editable by staff users.
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_slug string
customer_native_name string
customer_abbreviation string
description string Project description (HTML content will be sanitized)
customer_display_billing_info_in_projects boolean
created string (date-time)
type string (uri)
type_name string
type_uuid string (uuid)
backend_id string
start_date string (date) Project start date. Cannot be edited after the start date has arrived.
end_date string (date) Project end date. Setting this field requires DELETE_PROJECT permission.
end_date_requested_by string (uri)
oecd_fos_2007_code any
oecd_fos_2007_label string Human-readable label for the OECD FOS 2007 classification code
is_industry boolean
image string (uri)
resources_count integer Number of active resources in this project
max_service_accounts integer Maximum number of service accounts allowed
kind any
is_removed boolean
termination_metadata any Metadata about project termination (read-only)
staff_notes string Internal notes visible only to staff and support users (HTML content will be sanitized)
grace_period_days integer Number of extra days after project end date before resources are terminated. Overrides customer-level setting.
user_email_patterns any
user_affiliations any
user_identity_sources any List of allowed identity sources (identity providers).
project_credit number (double)
marketplace_resource_count object (free-form)
billing_price_estimate any

Retrieve project details

Fetch the details of a specific project by its UUID. Users can access details of terminated projects they previously had access to.

1
2
3
4
http \
  GET \
  https://api.example.com/api/openportal-unmanaged-projects/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.project_field_enum import ProjectFieldEnum # (1)
from waldur_api_client.api.openportal_unmanaged_projects import openportal_unmanaged_projects_retrieve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openportal_unmanaged_projects_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. Model Source: ProjectFieldEnum
  2. API Source: openportal_unmanaged_projects_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openportalUnmanagedProjectsRetrieve } from 'waldur-js-client';

try {
  const response = await openportalUnmanagedProjectsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type
field array

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
slug string URL-friendly identifier. Only editable by staff users.
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_slug string
customer_native_name string
customer_abbreviation string
description string Project description (HTML content will be sanitized)
customer_display_billing_info_in_projects boolean
created string (date-time)
type string (uri)
type_name string
type_uuid string (uuid)
backend_id string
start_date string (date) Project start date. Cannot be edited after the start date has arrived.
end_date string (date) Project end date. Setting this field requires DELETE_PROJECT permission.
end_date_requested_by string (uri)
oecd_fos_2007_code any
oecd_fos_2007_label string Human-readable label for the OECD FOS 2007 classification code
is_industry boolean
image string (uri)
resources_count integer Number of active resources in this project
max_service_accounts integer Maximum number of service accounts allowed
kind any
is_removed boolean
termination_metadata any Metadata about project termination (read-only)
staff_notes string Internal notes visible only to staff and support users (HTML content will be sanitized)
grace_period_days integer Number of extra days after project end date before resources are terminated. Overrides customer-level setting.
user_email_patterns any
user_affiliations any
user_identity_sources any List of allowed identity sources (identity providers).
project_credit number (double)
marketplace_resource_count object (free-form)
billing_price_estimate any

Create a new project

A new project can be created by users with staff privilege (is_staff=True) or customer owners. Project resource quota is optional.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/openportal-unmanaged-projects/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-openportal-unmanaged-project" \
  customer="https://api.example.com/api/customer/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.project_request import ProjectRequest # (1)
from waldur_api_client.api.openportal_unmanaged_projects import openportal_unmanaged_projects_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ProjectRequest(
    name="my-awesome-openportal-unmanaged-project",
    customer="https://api.example.com/api/customer/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = openportal_unmanaged_projects_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ProjectRequest
  2. API Source: openportal_unmanaged_projects_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { openportalUnmanagedProjectsCreate } from 'waldur-js-client';

try {
  const response = await openportalUnmanagedProjectsCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "name": "my-awesome-openportal-unmanaged-project",
    "customer": "https://api.example.com/api/customer/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
name string ✓
slug string URL-friendly identifier. Only editable by staff users.
customer string (uri) ✓
description string Project description (HTML content will be sanitized)
type string (uri)
backend_id string
start_date string (date) Project start date. Cannot be edited after the start date has arrived.
end_date string (date) Project end date. Setting this field requires DELETE_PROJECT permission.
oecd_fos_2007_code any
is_industry boolean
image string (binary)
kind any
staff_notes string Internal notes visible only to staff and support users (HTML content will be sanitized)
grace_period_days integer Number of extra days after project end date before resources are terminated. Overrides customer-level setting.
user_email_patterns any
user_affiliations any
user_identity_sources any List of allowed identity sources (identity providers).

201 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
slug string URL-friendly identifier. Only editable by staff users.
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_slug string
customer_native_name string
customer_abbreviation string
description string Project description (HTML content will be sanitized)
customer_display_billing_info_in_projects boolean
created string (date-time)
type string (uri)
type_name string
type_uuid string (uuid)
backend_id string
start_date string (date) Project start date. Cannot be edited after the start date has arrived.
end_date string (date) Project end date. Setting this field requires DELETE_PROJECT permission.
end_date_requested_by string (uri)
oecd_fos_2007_code any
oecd_fos_2007_label string Human-readable label for the OECD FOS 2007 classification code
is_industry boolean
image string (uri)
resources_count integer Number of active resources in this project
max_service_accounts integer Maximum number of service accounts allowed
kind any
is_removed boolean
termination_metadata any Metadata about project termination (read-only)
staff_notes string Internal notes visible only to staff and support users (HTML content will be sanitized)
grace_period_days integer Number of extra days after project end date before resources are terminated. Overrides customer-level setting.
user_email_patterns any
user_affiliations any
user_identity_sources any List of allowed identity sources (identity providers).
project_credit number (double)
marketplace_resource_count object (free-form)
billing_price_estimate any

Update project details

Update the details of a project. Requires project administrator or customer owner permissions.

1
2
3
4
5
6
http \
  PUT \
  https://api.example.com/api/openportal-unmanaged-projects/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-openportal-unmanaged-project" \
  customer="https://api.example.com/api/customer/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.project_request import ProjectRequest # (1)
from waldur_api_client.api.openportal_unmanaged_projects import openportal_unmanaged_projects_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ProjectRequest(
    name="my-awesome-openportal-unmanaged-project",
    customer="https://api.example.com/api/customer/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = openportal_unmanaged_projects_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ProjectRequest
  2. API Source: openportal_unmanaged_projects_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { openportalUnmanagedProjectsUpdate } from 'waldur-js-client';

try {
  const response = await openportalUnmanagedProjectsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-openportal-unmanaged-project",
    "customer": "https://api.example.com/api/customer/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
name string ✓
slug string URL-friendly identifier. Only editable by staff users.
customer string (uri) ✓
description string Project description (HTML content will be sanitized)
type string (uri)
backend_id string
start_date string (date) Project start date. Cannot be edited after the start date has arrived.
end_date string (date) Project end date. Setting this field requires DELETE_PROJECT permission.
oecd_fos_2007_code any
is_industry boolean
image string (binary)
kind any
staff_notes string Internal notes visible only to staff and support users (HTML content will be sanitized)
grace_period_days integer Number of extra days after project end date before resources are terminated. Overrides customer-level setting.
user_email_patterns any
user_affiliations any
user_identity_sources any List of allowed identity sources (identity providers).

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
slug string URL-friendly identifier. Only editable by staff users.
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_slug string
customer_native_name string
customer_abbreviation string
description string Project description (HTML content will be sanitized)
customer_display_billing_info_in_projects boolean
created string (date-time)
type string (uri)
type_name string
type_uuid string (uuid)
backend_id string
start_date string (date) Project start date. Cannot be edited after the start date has arrived.
end_date string (date) Project end date. Setting this field requires DELETE_PROJECT permission.
end_date_requested_by string (uri)
oecd_fos_2007_code any
oecd_fos_2007_label string Human-readable label for the OECD FOS 2007 classification code
is_industry boolean
image string (uri)
resources_count integer Number of active resources in this project
max_service_accounts integer Maximum number of service accounts allowed
kind any
is_removed boolean
termination_metadata any Metadata about project termination (read-only)
staff_notes string Internal notes visible only to staff and support users (HTML content will be sanitized)
grace_period_days integer Number of extra days after project end date before resources are terminated. Overrides customer-level setting.
user_email_patterns any
user_affiliations any
user_identity_sources any List of allowed identity sources (identity providers).
project_credit number (double)
marketplace_resource_count object (free-form)
billing_price_estimate any

Partially update project details

Partially update the details of a project. Requires project administrator or customer owner permissions.

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/openportal-unmanaged-projects/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_project_request import PatchedProjectRequest # (1)
from waldur_api_client.api.openportal_unmanaged_projects import openportal_unmanaged_projects_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedProjectRequest()
response = openportal_unmanaged_projects_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedProjectRequest
  2. API Source: openportal_unmanaged_projects_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openportalUnmanagedProjectsPartialUpdate } from 'waldur-js-client';

try {
  const response = await openportalUnmanagedProjectsPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
name string
slug string URL-friendly identifier. Only editable by staff users.
customer string (uri)
description string Project description (HTML content will be sanitized)
type string (uri)
backend_id string
start_date string (date) Project start date. Cannot be edited after the start date has arrived.
end_date string (date) Project end date. Setting this field requires DELETE_PROJECT permission.
oecd_fos_2007_code any
is_industry boolean
image string (binary)
kind any
staff_notes string Internal notes visible only to staff and support users (HTML content will be sanitized)
grace_period_days integer Number of extra days after project end date before resources are terminated. Overrides customer-level setting.
user_email_patterns any
user_affiliations any
user_identity_sources any List of allowed identity sources (identity providers).

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
slug string URL-friendly identifier. Only editable by staff users.
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_slug string
customer_native_name string
customer_abbreviation string
description string Project description (HTML content will be sanitized)
customer_display_billing_info_in_projects boolean
created string (date-time)
type string (uri)
type_name string
type_uuid string (uuid)
backend_id string
start_date string (date) Project start date. Cannot be edited after the start date has arrived.
end_date string (date) Project end date. Setting this field requires DELETE_PROJECT permission.
end_date_requested_by string (uri)
oecd_fos_2007_code any
oecd_fos_2007_label string Human-readable label for the OECD FOS 2007 classification code
is_industry boolean
image string (uri)
resources_count integer Number of active resources in this project
max_service_accounts integer Maximum number of service accounts allowed
kind any
is_removed boolean
termination_metadata any Metadata about project termination (read-only)
staff_notes string Internal notes visible only to staff and support users (HTML content will be sanitized)
grace_period_days integer Number of extra days after project end date before resources are terminated. Overrides customer-level setting.
user_email_patterns any
user_affiliations any
user_identity_sources any List of allowed identity sources (identity providers).
project_credit number (double)
marketplace_resource_count object (free-form)
billing_price_estimate any

Delete a project

Delete a project. If the project has any active resources, the deletion request will fail with a 409 Conflict response. This action performs a soft-delete, and the project can be recovered later.

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/openportal-unmanaged-projects/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openportal_unmanaged_projects import openportal_unmanaged_projects_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openportal_unmanaged_projects_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openportal_unmanaged_projects_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openportalUnmanagedProjectsDestroy } from 'waldur-js-client';

try {
  const response = await openportalUnmanagedProjectsDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Permissions & Users

List users and their roles in a scope

Retrieves a list of users who have a role within a specific scope (e.g., a project or an organization). The list can be filtered by user details or role.

1
2
3
4
http \
  GET \
  https://api.example.com/api/openportal-unmanaged-projects/a1b2c3d4-e5f6-7890-abcd-ef1234567890/list_users/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.user_role_details_field_enum import UserRoleDetailsFieldEnum # (1)
from waldur_api_client.models.user_role_details_o_enum import UserRoleDetailsOEnum # (2)
from waldur_api_client.api.openportal_unmanaged_projects import openportal_unmanaged_projects_list_users_list # (3)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openportal_unmanaged_projects_list_users_list.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

for item in response:
    print(item)
  1. Model Source: UserRoleDetailsFieldEnum
  2. Model Source: UserRoleDetailsOEnum
  3. API Source: openportal_unmanaged_projects_list_users_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openportalUnmanagedProjectsListUsersList } from 'waldur-js-client';

try {
  const response = await openportalUnmanagedProjectsListUsersList({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type Description
field array Fields to include in response
full_name string User full name
native_name string User native name
o array Ordering fields
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
role string (uuid) Role UUID or name
search_string string Search string for user
user string (uuid) User UUID
user_slug string User slug
user_url string User URL
username string User username

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid)
created string (date-time)
expiration_time string (date-time)
role_name string
role_uuid string (uuid)
user_email string (email)
user_full_name string
user_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
user_uuid string (uuid)
user_image string (uri)
created_by_full_name string
created_by_uuid string (uuid)

Grant a role to a user

Assigns a specific role to a user within the current scope. An optional expiration time for the role can be set.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/openportal-unmanaged-projects/a1b2c3d4-e5f6-7890-abcd-ef1234567890/add_user/ \
  Authorization:"Token YOUR_API_TOKEN" \
  role="string-value" \
  user="a1b2c3d4-e5f6-7890-abcd-ef1234567890"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.user_role_create_request import UserRoleCreateRequest # (1)
from waldur_api_client.api.openportal_unmanaged_projects import openportal_unmanaged_projects_add_user # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = UserRoleCreateRequest(
    role="string-value",
    user="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
)
response = openportal_unmanaged_projects_add_user.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: UserRoleCreateRequest
  2. API Source: openportal_unmanaged_projects_add_user
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { openportalUnmanagedProjectsAddUser } from 'waldur-js-client';

try {
  const response = await openportalUnmanagedProjectsAddUser({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "role": "string-value",
    "user": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
role string ✓
user string (uuid) ✓
expiration_time string (date-time)

201 -

Field Type
expiration_time string (date-time)

400 - Validation error, for example when trying to add a user to a terminated project.

Revoke a role from a user

Removes a specific role from a user within the current scope. This effectively revokes their permissions associated with that role.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/openportal-unmanaged-projects/a1b2c3d4-e5f6-7890-abcd-ef1234567890/delete_user/ \
  Authorization:"Token YOUR_API_TOKEN" \
  role="string-value" \
  user="a1b2c3d4-e5f6-7890-abcd-ef1234567890"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.user_role_delete_request import UserRoleDeleteRequest # (1)
from waldur_api_client.api.openportal_unmanaged_projects import openportal_unmanaged_projects_delete_user # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = UserRoleDeleteRequest(
    role="string-value",
    user="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
)
response = openportal_unmanaged_projects_delete_user.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: UserRoleDeleteRequest
  2. API Source: openportal_unmanaged_projects_delete_user
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { openportalUnmanagedProjectsDeleteUser } from 'waldur-js-client';

try {
  const response = await openportalUnmanagedProjectsDeleteUser({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "role": "string-value",
    "user": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
role string ✓
user string (uuid) ✓
expiration_time string (date-time)

200 - Role revoked successfully.

Update a user's role expiration

Updates the expiration time for a user's existing role in the current scope. This is useful for extending or shortening the duration of a permission. To make a role permanent, set expiration_time to null.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/openportal-unmanaged-projects/a1b2c3d4-e5f6-7890-abcd-ef1234567890/update_user/ \
  Authorization:"Token YOUR_API_TOKEN" \
  role="string-value" \
  user="a1b2c3d4-e5f6-7890-abcd-ef1234567890"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.user_role_update_request import UserRoleUpdateRequest # (1)
from waldur_api_client.api.openportal_unmanaged_projects import openportal_unmanaged_projects_update_user # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = UserRoleUpdateRequest(
    role="string-value",
    user="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
)
response = openportal_unmanaged_projects_update_user.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: UserRoleUpdateRequest
  2. API Source: openportal_unmanaged_projects_update_user
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { openportalUnmanagedProjectsUpdateUser } from 'waldur-js-client';

try {
  const response = await openportalUnmanagedProjectsUpdateUser({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "role": "string-value",
    "user": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
role string ✓
user string (uuid) ✓
expiration_time string (date-time)

200 -

Field Type
expiration_time string (date-time)

Other Actions

Get checklist with questions and existing answers

Get checklist with questions and existing answers.

1
2
3
4
http \
  GET \
  https://api.example.com/api/openportal-unmanaged-projects/a1b2c3d4-e5f6-7890-abcd-ef1234567890/checklist/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openportal_unmanaged_projects import openportal_unmanaged_projects_checklist_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openportal_unmanaged_projects_checklist_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openportal_unmanaged_projects_checklist_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openportalUnmanagedProjectsChecklistRetrieve } from 'waldur-js-client';

try {
  const response = await openportalUnmanagedProjectsChecklistRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type Description
include_all boolean If true, returns all questions including hidden ones (for dynamic form visibility). Default: false.

200 -

Field Type Description
checklist object (free-form)
completion object
completion.uuid string (uuid)
completion.is_completed boolean Whether all required questions have been answered
completion.completion_percentage number (double)
completion.unanswered_required_questions array of anys
completion.checklist_name string
completion.checklist_description string
completion.created string (date-time)
completion.modified string (date-time)
questions array of objects
questions.uuid string (uuid)
questions.description string
questions.user_guidance string
questions.question_type any Type of question and expected answer format
questions.required boolean
questions.order integer
questions.existing_answer object (free-form)
questions.question_options array of anys
questions.min_value string (decimal) Minimum value allowed for NUMBER, YEAR, and RATING type questions
questions.max_value string (decimal) Maximum value allowed for NUMBER, YEAR, and RATING type questions
questions.allowed_file_types any List of allowed file extensions (e.g., ['.pdf', '.doc', '.docx']). If empty, all file types are allowed.
questions.allowed_mime_types any List of allowed MIME types (e.g., ['application/pdf', 'application/msword']). If empty, MIME type validation is not enforced. When both extensions and MIME types are specified, files must match both criteria for security.
questions.max_file_size_mb integer Maximum file size in megabytes. If not set, no size limit is enforced.
questions.max_files_count integer Maximum number of files allowed for MULTIPLE_FILES type questions. If not set, no count limit is enforced.
questions.dependencies_info object (free-form)

400 -

404 -

Get checklist template for creating new objects

Get checklist template for creating new objects.

1
2
3
4
5
http \
  GET \
  https://api.example.com/api/openportal-unmanaged-projects/checklist-template/ \
  Authorization:"Token YOUR_API_TOKEN" \
  parent_uuid=="a1b2c3d4-e5f6-7890-abcd-ef1234567890"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openportal_unmanaged_projects import openportal_unmanaged_projects_checklist_template_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openportal_unmanaged_projects_checklist_template_retrieve.sync(
    client=client,
    parent_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
)

print(response)
  1. API Source: openportal_unmanaged_projects_checklist_template_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openportalUnmanagedProjectsChecklistTemplateRetrieve } from 'waldur-js-client';

try {
  const response = await openportalUnmanagedProjectsChecklistTemplateRetrieve({
  auth: "Token YOUR_API_TOKEN",
  query: {
    "parent_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
parent_uuid string (uuid) ✓ UUID of the parent object (e.g., customer UUID for new projects)

200 -

Field Type Description
checklist object (free-form)
questions array of objects
questions.uuid string (uuid)
questions.required boolean
questions.description string
questions.user_guidance string Additional guidance text visible to users when answering and reviewing
questions.question_options array of objects
questions.question_options.uuid string (uuid)
questions.question_options.label string
questions.question_options.order integer
questions.question_type any Type of question and expected answer format
questions.order integer
questions.min_value string (decimal) Minimum value allowed for NUMBER, YEAR, and RATING type questions
questions.max_value string (decimal) Maximum value allowed for NUMBER, YEAR, and RATING type questions
questions.allowed_file_types any List of allowed file extensions (e.g., ['.pdf', '.doc', '.docx']). If empty, all file types are allowed.
questions.allowed_mime_types any List of allowed MIME types (e.g., ['application/pdf', 'application/msword']). If empty, MIME type validation is not enforced. When both extensions and MIME types are specified, files must match both criteria for security.
questions.max_file_size_mb integer Maximum file size in megabytes. If not set, no size limit is enforced.
questions.max_files_count integer Maximum number of files allowed for MULTIPLE_FILES type questions. If not set, no count limit is enforced.
questions.operator any
questions.review_answer_value any Answer value that trigger review.
questions.always_requires_review boolean This question always requires review regardless of answer
questions.guidance_answer_value any Answer value that triggers display of user guidance.
questions.guidance_operator any Operator to use when comparing answer with guidance_answer_value
questions.always_show_guidance boolean Show user guidance always, regardless of answer. If False, guidance is conditional on answer matching guidance_answer_value with guidance_operator
questions.dependency_logic_operator any Defines how multiple dependencies are evaluated. AND: All dependencies must be satisfied. OR: At least one dependency must be satisfied.
initial_visible_questions array of objects
initial_visible_questions.uuid string (uuid)
initial_visible_questions.required boolean
initial_visible_questions.description string
initial_visible_questions.user_guidance string Additional guidance text visible to users when answering and reviewing
initial_visible_questions.question_options array of objects
initial_visible_questions.question_options.uuid string (uuid)
initial_visible_questions.question_options.label string
initial_visible_questions.question_options.order integer
initial_visible_questions.question_type any Type of question and expected answer format
initial_visible_questions.order integer
initial_visible_questions.min_value string (decimal) Minimum value allowed for NUMBER, YEAR, and RATING type questions
initial_visible_questions.max_value string (decimal) Maximum value allowed for NUMBER, YEAR, and RATING type questions
initial_visible_questions.allowed_file_types any List of allowed file extensions (e.g., ['.pdf', '.doc', '.docx']). If empty, all file types are allowed.
initial_visible_questions.allowed_mime_types any List of allowed MIME types (e.g., ['application/pdf', 'application/msword']). If empty, MIME type validation is not enforced. When both extensions and MIME types are specified, files must match both criteria for security.
initial_visible_questions.max_file_size_mb integer Maximum file size in megabytes. If not set, no size limit is enforced.
initial_visible_questions.max_files_count integer Maximum number of files allowed for MULTIPLE_FILES type questions. If not set, no count limit is enforced.
initial_visible_questions.operator any
initial_visible_questions.review_answer_value any Answer value that trigger review.
initial_visible_questions.always_requires_review boolean This question always requires review regardless of answer
initial_visible_questions.guidance_answer_value any Answer value that triggers display of user guidance.
initial_visible_questions.guidance_operator any Operator to use when comparing answer with guidance_answer_value
initial_visible_questions.always_show_guidance boolean Show user guidance always, regardless of answer. If False, guidance is conditional on answer matching guidance_answer_value with guidance_operator
initial_visible_questions.dependency_logic_operator any Defines how multiple dependencies are evaluated. AND: All dependencies must be satisfied. OR: At least one dependency must be satisfied.

400 -

404 -

Get checklist completion status

Get checklist completion status.

1
2
3
4
http \
  GET \
  https://api.example.com/api/openportal-unmanaged-projects/a1b2c3d4-e5f6-7890-abcd-ef1234567890/completion_status/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openportal_unmanaged_projects import openportal_unmanaged_projects_completion_status_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openportal_unmanaged_projects_completion_status_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openportal_unmanaged_projects_completion_status_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openportalUnmanagedProjectsCompletionStatusRetrieve } from 'waldur-js-client';

try {
  const response = await openportalUnmanagedProjectsCompletionStatusRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
uuid string (uuid)
is_completed boolean Whether all required questions have been answered
completion_percentage number (double)
unanswered_required_questions array of anys
checklist_name string
checklist_description string
created string (date-time)
modified string (date-time)

400 -

404 -

Get project resource usage statistics

Provides statistics about the resource usage (e.g., CPU, RAM, storage) for all resources within a project. Can be filtered to show usage for the current month only.

1
2
3
4
http \
  GET \
  https://api.example.com/api/openportal-unmanaged-projects/a1b2c3d4-e5f6-7890-abcd-ef1234567890/stats/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openportal_unmanaged_projects import openportal_unmanaged_projects_stats_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openportal_unmanaged_projects_stats_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openportal_unmanaged_projects_stats_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openportalUnmanagedProjectsStatsRetrieve } from 'waldur-js-client';

try {
  const response = await openportalUnmanagedProjectsStatsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type Description
for_current_month boolean If true, returns usage data for the current month only. Otherwise, returns total usage.

200 -

Field Type
components array of objects
components.type string
components.name string
components.description string
components.measured_unit string
components.billing_type string
components.usage integer
components.limit_usage integer
components.limit integer
components.offering_name string
components.offering_uuid string (uuid)

Move project to another customer

Moves a project and its associated resources to a different customer. You can choose whether to preserve existing project permissions for users. Terminated projects can also be moved.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/openportal-unmanaged-projects/a1b2c3d4-e5f6-7890-abcd-ef1234567890/move_project/ \
  Authorization:"Token YOUR_API_TOKEN" \
  customer="https://api.example.com/api/customer/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  preserve_permissions=true

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.move_project_request import MoveProjectRequest # (1)
from waldur_api_client.api.openportal_unmanaged_projects import openportal_unmanaged_projects_move_project # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = MoveProjectRequest(
    customer="https://api.example.com/api/customer/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    preserve_permissions=true
)
response = openportal_unmanaged_projects_move_project.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: MoveProjectRequest
  2. API Source: openportal_unmanaged_projects_move_project
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { openportalUnmanagedProjectsMoveProject } from 'waldur-js-client';

try {
  const response = await openportalUnmanagedProjectsMoveProject({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "customer": "https://api.example.com/api/customer/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "preserve_permissions": true
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
customer string (uri) ✓
preserve_permissions boolean ✓

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
slug string URL-friendly identifier. Only editable by staff users.
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_slug string
customer_native_name string
customer_abbreviation string
description string Project description (HTML content will be sanitized)
customer_display_billing_info_in_projects boolean
created string (date-time)
type string (uri)
type_name string
type_uuid string (uuid)
backend_id string
start_date string (date) Project start date. Cannot be edited after the start date has arrived.
end_date string (date) Project end date. Setting this field requires DELETE_PROJECT permission.
end_date_requested_by string (uri)
oecd_fos_2007_code any
oecd_fos_2007_label string Human-readable label for the OECD FOS 2007 classification code
is_industry boolean
image string (uri)
resources_count integer Number of active resources in this project
max_service_accounts integer Maximum number of service accounts allowed
kind any
is_removed boolean
termination_metadata any Metadata about project termination (read-only)
staff_notes string Internal notes visible only to staff and support users (HTML content will be sanitized)
grace_period_days integer Number of extra days after project end date before resources are terminated. Overrides customer-level setting.
user_email_patterns any
user_affiliations any
user_identity_sources any List of allowed identity sources (identity providers).
project_credit number (double)
marketplace_resource_count object (free-form)
billing_price_estimate any

Recover a soft-deleted project

Recovers a soft-deleted (terminated) project, making it active again. Provides options to restore previous team members automatically (staff-only) or send them new invitations.

1
2
3
4
http \
  POST \
  https://api.example.com/api/openportal-unmanaged-projects/a1b2c3d4-e5f6-7890-abcd-ef1234567890/recover/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.project_recovery_request import ProjectRecoveryRequest # (1)
from waldur_api_client.api.openportal_unmanaged_projects import openportal_unmanaged_projects_recover # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ProjectRecoveryRequest()
response = openportal_unmanaged_projects_recover.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ProjectRecoveryRequest
  2. API Source: openportal_unmanaged_projects_recover
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openportalUnmanagedProjectsRecover } from 'waldur-js-client';

try {
  const response = await openportalUnmanagedProjectsRecover({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
restore_team_members boolean Whether to automatically restore team members who had access before project deletion (staff only)
Constraints: default: False
send_invitations_to_previous_members boolean Whether to send invitations to users who had access before project deletion
Constraints: default: False
end_date string (date) End date for the recovered project

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
slug string URL-friendly identifier. Only editable by staff users.
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_slug string
customer_native_name string
customer_abbreviation string
description string Project description (HTML content will be sanitized)
customer_display_billing_info_in_projects boolean
created string (date-time)
type string (uri)
type_name string
type_uuid string (uuid)
backend_id string
start_date string (date) Project start date. Cannot be edited after the start date has arrived.
end_date string (date) Project end date. Setting this field requires DELETE_PROJECT permission.
end_date_requested_by string (uri)
oecd_fos_2007_code any
oecd_fos_2007_label string Human-readable label for the OECD FOS 2007 classification code
is_industry boolean
image string (uri)
resources_count integer Number of active resources in this project
max_service_accounts integer Maximum number of service accounts allowed
kind any
is_removed boolean
termination_metadata any Metadata about project termination (read-only)
staff_notes string Internal notes visible only to staff and support users (HTML content will be sanitized)
grace_period_days integer Number of extra days after project end date before resources are terminated. Overrides customer-level setting.
user_email_patterns any
user_affiliations any
user_identity_sources any List of allowed identity sources (identity providers).
project_credit number (double)
marketplace_resource_count object (free-form)
billing_price_estimate any

Submit checklist answers

Submit checklist answers.

1
2
3
4
echo '[{"question_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "answer_data": null}]' | http \
  POST \
  https://api.example.com/api/openportal-unmanaged-projects/a1b2c3d4-e5f6-7890-abcd-ef1234567890/submit_answers/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openportal_unmanaged_projects import openportal_unmanaged_projects_submit_answers # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openportal_unmanaged_projects_submit_answers.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openportal_unmanaged_projects_submit_answers
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { openportalUnmanagedProjectsSubmitAnswers } from 'waldur-js-client';

try {
  const response = await openportalUnmanagedProjectsSubmitAnswers({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: [{"question_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "answer_data": null}]
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

The request body is an array of objects, where each object has the following structure:

Field Type Required
question_uuid string (uuid) ✓
answer_data any ✓

200 -

Field Type Description
detail string
completion object
completion.uuid string (uuid)
completion.is_completed boolean Whether all required questions have been answered
completion.completion_percentage number (double)
completion.unanswered_required_questions array of anys
completion.checklist_name string
completion.checklist_description string
completion.created string (date-time)
completion.modified string (date-time)

400 -

404 -

Openportal Userinfo

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/openportal-userinfo/ List Openportal Userinfo
GET /api/openportal-userinfo/{user}/ Retrieve
POST /api/openportal-userinfo/ Create
PUT /api/openportal-userinfo/{user}/ Update
PATCH /api/openportal-userinfo/{user}/ Partial Update
DELETE /api/openportal-userinfo/{user}/ Delete
Other Actions
GET /api/openportal-userinfo/me/ List Openportal Userinfo Me
PUT /api/openportal-userinfo/{user}/set_shortname/ Set shortname

Core CRUD

List Openportal Userinfo

1
2
3
4
http \
  GET \
  https://api.example.com/api/openportal-userinfo/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openportal_userinfo import openportal_userinfo_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openportal_userinfo_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: openportal_userinfo_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { openportalUserinfoList } from 'waldur-js-client';

try {
  const response = await openportalUserinfoList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
user string (uri)
user_uuid string (uuid)

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
shortname string A short, unique name for you. It will be used to form your local username on any systems. Should only contain lower-case letters and digits and must start with a letter.
user string (uri)

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/openportal-userinfo/123/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openportal_userinfo import openportal_userinfo_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openportal_userinfo_retrieve.sync(
    user=123,
    client=client
)

print(response)
  1. API Source: openportal_userinfo_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openportalUserinfoRetrieve } from 'waldur-js-client';

try {
  const response = await openportalUserinfoRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "user": 123
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
user integer (uri) ✓

200 -

Field Type Description
shortname string A short, unique name for you. It will be used to form your local username on any systems. Should only contain lower-case letters and digits and must start with a letter.
user string (uri)

Create

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/openportal-userinfo/ \
  Authorization:"Token YOUR_API_TOKEN" \
  user="https://api.example.com/api/user/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.user_info_request import UserInfoRequest # (1)
from waldur_api_client.api.openportal_userinfo import openportal_userinfo_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = UserInfoRequest(
    user="https://api.example.com/api/user/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = openportal_userinfo_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: UserInfoRequest
  2. API Source: openportal_userinfo_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openportalUserinfoCreate } from 'waldur-js-client';

try {
  const response = await openportalUserinfoCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "user": "https://api.example.com/api/user/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
shortname string A short, unique name for you. It will be used to form your local username on any systems. Should only contain lower-case letters and digits and must start with a letter.
user string (uri) ✓

201 -

Field Type Description
shortname string A short, unique name for you. It will be used to form your local username on any systems. Should only contain lower-case letters and digits and must start with a letter.
user string (uri)

Update

1
2
3
4
5
http \
  PUT \
  https://api.example.com/api/openportal-userinfo/123/ \
  Authorization:"Token YOUR_API_TOKEN" \
  user="https://api.example.com/api/user/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.user_info_request import UserInfoRequest # (1)
from waldur_api_client.api.openportal_userinfo import openportal_userinfo_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = UserInfoRequest(
    user="https://api.example.com/api/user/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = openportal_userinfo_update.sync(
    user=123,
    client=client,
    body=body_data
)

print(response)
  1. Model Source: UserInfoRequest
  2. API Source: openportal_userinfo_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { openportalUserinfoUpdate } from 'waldur-js-client';

try {
  const response = await openportalUserinfoUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "user": 123
  },
  body: {
    "user": "https://api.example.com/api/user/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
user integer (uri) ✓
Field Type Required Description
shortname string A short, unique name for you. It will be used to form your local username on any systems. Should only contain lower-case letters and digits and must start with a letter.
user string (uri) ✓

200 -

Field Type Description
shortname string A short, unique name for you. It will be used to form your local username on any systems. Should only contain lower-case letters and digits and must start with a letter.
user string (uri)

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/openportal-userinfo/123/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_user_info_request import PatchedUserInfoRequest # (1)
from waldur_api_client.api.openportal_userinfo import openportal_userinfo_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedUserInfoRequest()
response = openportal_userinfo_partial_update.sync(
    user=123,
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedUserInfoRequest
  2. API Source: openportal_userinfo_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openportalUserinfoPartialUpdate } from 'waldur-js-client';

try {
  const response = await openportalUserinfoPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "user": 123
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
user integer (uri) ✓
Field Type Required Description
shortname string A short, unique name for you. It will be used to form your local username on any systems. Should only contain lower-case letters and digits and must start with a letter.
user string (uri)

200 -

Field Type Description
shortname string A short, unique name for you. It will be used to form your local username on any systems. Should only contain lower-case letters and digits and must start with a letter.
user string (uri)

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/openportal-userinfo/123/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openportal_userinfo import openportal_userinfo_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openportal_userinfo_destroy.sync(
    user=123,
    client=client
)

print(response)
  1. API Source: openportal_userinfo_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openportalUserinfoDestroy } from 'waldur-js-client';

try {
  const response = await openportalUserinfoDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "user": 123
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
user integer (uri) ✓

204 - No response body

Other Actions

List Openportal Userinfo Me

1
2
3
4
http \
  GET \
  https://api.example.com/api/openportal-userinfo/me/ \
  Authorization:"Token YOUR_API_TOKEN"

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openportal_userinfo import openportal_userinfo_me_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openportal_userinfo_me_retrieve.sync(client=client)

print(response)
  1. API Source: openportal_userinfo_me_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { openportalUserinfoMeRetrieve } from 'waldur-js-client';

try {
  const response = await openportalUserinfoMeRetrieve({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

200 -

Field Type Description
shortname string A short, unique name for you. It will be used to form your local username on any systems. Should only contain lower-case letters and digits and must start with a letter.
user string (uri)

Set shortname

1
2
3
4
5
http \
  PUT \
  https://api.example.com/api/openportal-userinfo/123/set_shortname/ \
  Authorization:"Token YOUR_API_TOKEN" \
  user="https://api.example.com/api/user/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.user_info_request import UserInfoRequest # (1)
from waldur_api_client.api.openportal_userinfo import openportal_userinfo_set_shortname_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = UserInfoRequest(
    user="https://api.example.com/api/user/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = openportal_userinfo_set_shortname_update.sync(
    user=123,
    client=client,
    body=body_data
)

print(response)
  1. Model Source: UserInfoRequest
  2. API Source: openportal_userinfo_set_shortname_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { openportalUserinfoSetShortnameUpdate } from 'waldur-js-client';

try {
  const response = await openportalUserinfoSetShortnameUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "user": 123
  },
  body: {
    "user": "https://api.example.com/api/user/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
user integer (uri) ✓
Field Type Required Description
shortname string A short, unique name for you. It will be used to form your local username on any systems. Should only contain lower-case letters and digits and must start with a letter.
user string (uri) ✓

200 -

Field Type Description
shortname string A short, unique name for you. It will be used to form your local username on any systems. Should only contain lower-case letters and digits and must start with a letter.
user string (uri)

Openstack

Openstack Backups

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/openstack-backups/ List backups
GET /api/openstack-backups/{uuid}/ Get backup details
POST /api/openstack-backups/{uuid}/pull/ Synchronize resource state
POST /api/openstack-backups/{uuid}/unlink/ Unlink resource
PUT /api/openstack-backups/{uuid}/ Update backup
PATCH /api/openstack-backups/{uuid}/ Partially update backup
DELETE /api/openstack-backups/{uuid}/ Delete backup
Other Actions
POST /api/openstack-backups/{uuid}/restore/ Restore instance from backup
POST /api/openstack-backups/{uuid}/set_erred/ Mark resource as ERRED
POST /api/openstack-backups/{uuid}/set_ok/ Mark resource as OK

Core CRUD

List backups

Get a list of instance backups.

1
2
3
4
http \
  GET \
  https://api.example.com/api/openstack-backups/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.core_states import CoreStates # (1)
from waldur_api_client.models.open_stack_backup_field_enum import OpenStackBackupFieldEnum # (2)
from waldur_api_client.api.openstack_backups import openstack_backups_list # (3)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_backups_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: CoreStates
  2. Model Source: OpenStackBackupFieldEnum
  3. API Source: openstack_backups_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { openstackBackupsList } from 'waldur-js-client';

try {
  const response = await openstackBackupsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
backend_id string Backend ID
can_manage boolean Can manage
customer string (uuid) Customer UUID
customer_abbreviation string Customer abbreviation
customer_name string Customer name
customer_native_name string Customer native name
customer_uuid string (uuid) Customer UUID
description string Description
external_ip string External IP
field array
instance string (uri) Instance URL
instance_uuid string (uuid) Instance UUID
name string Name
name_exact string Name (exact)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
project string (uuid) Project UUID
project_name string Project name
project_uuid string (uuid) Project UUID
service_settings_name string Service settings name
service_settings_uuid string (uuid) Service settings UUID
state array State
tenant string (uri) Tenant URL
tenant_uuid string (uuid) Tenant UUID
uuid string (uuid) UUID

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
kept_until string (date-time) Guaranteed time of backup retention. If null - keep forever.
metadata any
instance string (uri) Instance that this backup is created from
instance_name string
instance_marketplace_uuid string (uuid)
restorations array of objects
restorations.uuid string (uuid)
restorations.instance string (uri) Instance that is being restored from the backup
restorations.created string (date-time)
restorations.flavor string (uri) Flavor to be used for the restored instance. If not specified, original instance flavor will be used
restorations.name string New instance name. Leave blank to use source instance name.
restorations.floating_ips array of objects
restorations.floating_ips.url string (uri)
restorations.floating_ips.uuid string (uuid)
restorations.floating_ips.address any The public IPv4 address of the floating IP
restorations.floating_ips.port_fixed_ips array of objects
restorations.floating_ips.port_fixed_ips.ip_address any IP address to assign to the port
restorations.floating_ips.port_fixed_ips.subnet_id string ID of the subnet in which to assign the IP address
restorations.floating_ips.port_mac_address string MAC address of the port
restorations.floating_ips.subnet string (uri)
restorations.floating_ips.subnet_uuid string (uuid)
restorations.floating_ips.subnet_name string
restorations.floating_ips.subnet_description string
restorations.floating_ips.subnet_cidr string IPv4 network address in CIDR format (e.g. 192.168.0.0/24)
restorations.security_groups array of objects
restorations.security_groups.url string (uri)
restorations.security_groups.name string
restorations.security_groups.rules array of objects
restorations.security_groups.rules.ethertype any IP protocol version - either 'IPv4' or 'IPv6'
restorations.security_groups.rules.direction any Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing)
restorations.security_groups.rules.protocol any The network protocol (TCP, UDP, ICMP, or empty for any protocol)
restorations.security_groups.rules.from_port integer Starting port number in the range (1-65535)
restorations.security_groups.rules.to_port integer Ending port number in the range (1-65535)
restorations.security_groups.rules.cidr string CIDR notation for the source/destination network address range
restorations.security_groups.rules.description string
restorations.security_groups.rules.remote_group_name string
restorations.security_groups.rules.remote_group_uuid string (uuid)
restorations.security_groups.rules.id integer
restorations.security_groups.description string
restorations.security_groups.state string
restorations.ports array of objects
restorations.ports.url string (uri)
restorations.ports.fixed_ips array of objects
restorations.ports.fixed_ips.ip_address any IP address to assign to the port
restorations.ports.fixed_ips.subnet_id string ID of the subnet in which to assign the IP address
restorations.ports.mac_address string MAC address of the port
restorations.ports.subnet string (uri) Subnet to which this port belongs
restorations.ports.subnet_uuid string (uuid)
restorations.ports.subnet_name string
restorations.ports.subnet_description string
restorations.ports.subnet_cidr string IPv4 network address in CIDR format (e.g. 192.168.0.0/24)
restorations.ports.allowed_address_pairs array of objects
restorations.ports.allowed_address_pairs.mac_address string
restorations.ports.device_id string ID of device (instance, router etc) to which this port is connected
restorations.ports.device_owner string Entity that uses this port (e.g. network:router_interface)
restorations.ports.security_groups array of objects
restorations.ports.security_groups.url string (uri)
restorations.ports.security_groups.uuid string (uuid)
restorations.ports.security_groups.name string
restorations.ports.security_groups.description string
restorations.ports.security_groups.service_name string
restorations.ports.security_groups.service_settings string (uri)
restorations.ports.security_groups.service_settings_uuid string (uuid)
restorations.ports.security_groups.service_settings_state string
restorations.ports.security_groups.service_settings_error_message string
restorations.ports.security_groups.project string (uri)
restorations.ports.security_groups.project_name string
restorations.ports.security_groups.project_uuid string (uuid)
restorations.ports.security_groups.customer string (uri)
restorations.ports.security_groups.customer_uuid string (uuid)
restorations.ports.security_groups.customer_name string
restorations.ports.security_groups.customer_native_name string
restorations.ports.security_groups.customer_abbreviation string
restorations.ports.security_groups.error_message string
restorations.ports.security_groups.error_traceback string
restorations.ports.security_groups.resource_type string
restorations.ports.security_groups.state any
restorations.ports.security_groups.created string (date-time)
restorations.ports.security_groups.modified string (date-time)
restorations.ports.security_groups.backend_id string
restorations.ports.security_groups.access_url string
restorations.ports.security_groups.tenant string (uri)
restorations.ports.security_groups.tenant_name string
restorations.ports.security_groups.tenant_uuid string (uuid)
restorations.ports.security_groups.rules array of objects
restorations.ports.security_groups.rules.ethertype any IP protocol version - either 'IPv4' or 'IPv6'
restorations.ports.security_groups.rules.direction any Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing)
restorations.ports.security_groups.rules.protocol any The network protocol (TCP, UDP, ICMP, or empty for any protocol)
restorations.ports.security_groups.rules.from_port integer Starting port number in the range (1-65535)
restorations.ports.security_groups.rules.to_port integer Ending port number in the range (1-65535)
restorations.ports.security_groups.rules.cidr string CIDR notation for the source/destination network address range
restorations.ports.security_groups.rules.description string
restorations.ports.security_groups.rules.remote_group_name string
restorations.ports.security_groups.rules.remote_group_uuid string (uuid)
restorations.ports.security_groups.rules.id integer
restorations.ports.security_groups.rules.remote_group string (uri) Remote security group that this rule references, if any
restorations.ports.security_groups.marketplace_offering_uuid string
restorations.ports.security_groups.marketplace_offering_name string
restorations.ports.security_groups.marketplace_offering_plugin_options object (free-form)
restorations.ports.security_groups.marketplace_category_uuid string
restorations.ports.security_groups.marketplace_category_name string
restorations.ports.security_groups.marketplace_resource_uuid string
restorations.ports.security_groups.marketplace_plan_uuid string
restorations.ports.security_groups.marketplace_resource_state string
restorations.ports.security_groups.is_usage_based boolean
restorations.ports.security_groups.is_limit_based boolean
instance_security_groups array of objects
instance_security_groups.url string (uri)
instance_security_groups.name string
instance_security_groups.rules array of objects
instance_security_groups.rules.ethertype any IP protocol version - either 'IPv4' or 'IPv6'
instance_security_groups.rules.direction any Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing)
instance_security_groups.rules.protocol any The network protocol (TCP, UDP, ICMP, or empty for any protocol)
instance_security_groups.rules.from_port integer Starting port number in the range (1-65535)
instance_security_groups.rules.to_port integer Ending port number in the range (1-65535)
instance_security_groups.rules.cidr string CIDR notation for the source/destination network address range
instance_security_groups.rules.description string
instance_security_groups.rules.remote_group_name string
instance_security_groups.rules.remote_group_uuid string (uuid)
instance_security_groups.rules.id integer
instance_security_groups.description string
instance_security_groups.state string
instance_ports array of objects
instance_ports.url string (uri)
instance_ports.fixed_ips array of objects
instance_ports.fixed_ips.ip_address any IP address to assign to the port
instance_ports.fixed_ips.subnet_id string ID of the subnet in which to assign the IP address
instance_ports.mac_address string MAC address of the port
instance_ports.subnet string (uri) Subnet to which this port belongs
instance_ports.subnet_uuid string (uuid)
instance_ports.subnet_name string
instance_ports.subnet_description string
instance_ports.subnet_cidr string IPv4 network address in CIDR format (e.g. 192.168.0.0/24)
instance_ports.allowed_address_pairs array of objects
instance_ports.allowed_address_pairs.mac_address string
instance_ports.device_id string ID of device (instance, router etc) to which this port is connected
instance_ports.device_owner string Entity that uses this port (e.g. network:router_interface)
instance_ports.security_groups array of objects
instance_ports.security_groups.url string (uri)
instance_ports.security_groups.uuid string (uuid)
instance_ports.security_groups.name string
instance_ports.security_groups.description string
instance_ports.security_groups.service_name string
instance_ports.security_groups.service_settings string (uri)
instance_ports.security_groups.service_settings_uuid string (uuid)
instance_ports.security_groups.service_settings_state string
instance_ports.security_groups.service_settings_error_message string
instance_ports.security_groups.project string (uri)
instance_ports.security_groups.project_name string
instance_ports.security_groups.project_uuid string (uuid)
instance_ports.security_groups.customer string (uri)
instance_ports.security_groups.customer_uuid string (uuid)
instance_ports.security_groups.customer_name string
instance_ports.security_groups.customer_native_name string
instance_ports.security_groups.customer_abbreviation string
instance_ports.security_groups.error_message string
instance_ports.security_groups.error_traceback string
instance_ports.security_groups.resource_type string
instance_ports.security_groups.state any
instance_ports.security_groups.created string (date-time)
instance_ports.security_groups.modified string (date-time)
instance_ports.security_groups.backend_id string
instance_ports.security_groups.access_url string
instance_ports.security_groups.tenant string (uri)
instance_ports.security_groups.tenant_name string
instance_ports.security_groups.tenant_uuid string (uuid)
instance_ports.security_groups.rules array of objects
instance_ports.security_groups.rules.ethertype any IP protocol version - either 'IPv4' or 'IPv6'
instance_ports.security_groups.rules.direction any Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing)
instance_ports.security_groups.rules.protocol any The network protocol (TCP, UDP, ICMP, or empty for any protocol)
instance_ports.security_groups.rules.from_port integer Starting port number in the range (1-65535)
instance_ports.security_groups.rules.to_port integer Ending port number in the range (1-65535)
instance_ports.security_groups.rules.cidr string CIDR notation for the source/destination network address range
instance_ports.security_groups.rules.description string
instance_ports.security_groups.rules.remote_group_name string
instance_ports.security_groups.rules.remote_group_uuid string (uuid)
instance_ports.security_groups.rules.id integer
instance_ports.security_groups.rules.remote_group string (uri) Remote security group that this rule references, if any
instance_ports.security_groups.marketplace_offering_uuid string
instance_ports.security_groups.marketplace_offering_name string
instance_ports.security_groups.marketplace_offering_plugin_options object (free-form)
instance_ports.security_groups.marketplace_category_uuid string
instance_ports.security_groups.marketplace_category_name string
instance_ports.security_groups.marketplace_resource_uuid string
instance_ports.security_groups.marketplace_plan_uuid string
instance_ports.security_groups.marketplace_resource_state string
instance_ports.security_groups.is_usage_based boolean
instance_ports.security_groups.is_limit_based boolean
instance_floating_ips array of objects
instance_floating_ips.url string (uri)
instance_floating_ips.uuid string (uuid)
instance_floating_ips.address any The public IPv4 address of the floating IP
instance_floating_ips.port_fixed_ips array of objects
instance_floating_ips.port_fixed_ips.ip_address any IP address to assign to the port
instance_floating_ips.port_fixed_ips.subnet_id string ID of the subnet in which to assign the IP address
instance_floating_ips.port_mac_address string MAC address of the port
instance_floating_ips.subnet string (uri)
instance_floating_ips.subnet_uuid string (uuid)
instance_floating_ips.subnet_name string
instance_floating_ips.subnet_description string
instance_floating_ips.subnet_cidr string IPv4 network address in CIDR format (e.g. 192.168.0.0/24)
tenant_uuid string (uuid)
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Get backup details

Retrieve details of a specific instance backup.

1
2
3
4
http \
  GET \
  https://api.example.com/api/openstack-backups/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.open_stack_backup_field_enum import OpenStackBackupFieldEnum # (1)
from waldur_api_client.api.openstack_backups import openstack_backups_retrieve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_backups_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. Model Source: OpenStackBackupFieldEnum
  2. API Source: openstack_backups_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackBackupsRetrieve } from 'waldur-js-client';

try {
  const response = await openstackBackupsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type
field array

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
kept_until string (date-time) Guaranteed time of backup retention. If null - keep forever.
metadata any
instance string (uri) Instance that this backup is created from
instance_name string
instance_marketplace_uuid string (uuid)
restorations array of objects
restorations.uuid string (uuid)
restorations.instance string (uri) Instance that is being restored from the backup
restorations.created string (date-time)
restorations.flavor string (uri) Flavor to be used for the restored instance. If not specified, original instance flavor will be used
restorations.name string New instance name. Leave blank to use source instance name.
restorations.floating_ips array of objects
restorations.floating_ips.url string (uri)
restorations.floating_ips.uuid string (uuid)
restorations.floating_ips.address any The public IPv4 address of the floating IP
restorations.floating_ips.port_fixed_ips array of objects
restorations.floating_ips.port_fixed_ips.ip_address any IP address to assign to the port
restorations.floating_ips.port_fixed_ips.subnet_id string ID of the subnet in which to assign the IP address
restorations.floating_ips.port_mac_address string MAC address of the port
restorations.floating_ips.subnet string (uri)
restorations.floating_ips.subnet_uuid string (uuid)
restorations.floating_ips.subnet_name string
restorations.floating_ips.subnet_description string
restorations.floating_ips.subnet_cidr string IPv4 network address in CIDR format (e.g. 192.168.0.0/24)
restorations.security_groups array of objects
restorations.security_groups.url string (uri)
restorations.security_groups.name string
restorations.security_groups.rules array of objects
restorations.security_groups.rules.ethertype any IP protocol version - either 'IPv4' or 'IPv6'
restorations.security_groups.rules.direction any Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing)
restorations.security_groups.rules.protocol any The network protocol (TCP, UDP, ICMP, or empty for any protocol)
restorations.security_groups.rules.from_port integer Starting port number in the range (1-65535)
restorations.security_groups.rules.to_port integer Ending port number in the range (1-65535)
restorations.security_groups.rules.cidr string CIDR notation for the source/destination network address range
restorations.security_groups.rules.description string
restorations.security_groups.rules.remote_group_name string
restorations.security_groups.rules.remote_group_uuid string (uuid)
restorations.security_groups.rules.id integer
restorations.security_groups.description string
restorations.security_groups.state string
restorations.ports array of objects
restorations.ports.url string (uri)
restorations.ports.fixed_ips array of objects
restorations.ports.fixed_ips.ip_address any IP address to assign to the port
restorations.ports.fixed_ips.subnet_id string ID of the subnet in which to assign the IP address
restorations.ports.mac_address string MAC address of the port
restorations.ports.subnet string (uri) Subnet to which this port belongs
restorations.ports.subnet_uuid string (uuid)
restorations.ports.subnet_name string
restorations.ports.subnet_description string
restorations.ports.subnet_cidr string IPv4 network address in CIDR format (e.g. 192.168.0.0/24)
restorations.ports.allowed_address_pairs array of objects
restorations.ports.allowed_address_pairs.mac_address string
restorations.ports.device_id string ID of device (instance, router etc) to which this port is connected
restorations.ports.device_owner string Entity that uses this port (e.g. network:router_interface)
restorations.ports.security_groups array of objects
restorations.ports.security_groups.url string (uri)
restorations.ports.security_groups.uuid string (uuid)
restorations.ports.security_groups.name string
restorations.ports.security_groups.description string
restorations.ports.security_groups.service_name string
restorations.ports.security_groups.service_settings string (uri)
restorations.ports.security_groups.service_settings_uuid string (uuid)
restorations.ports.security_groups.service_settings_state string
restorations.ports.security_groups.service_settings_error_message string
restorations.ports.security_groups.project string (uri)
restorations.ports.security_groups.project_name string
restorations.ports.security_groups.project_uuid string (uuid)
restorations.ports.security_groups.customer string (uri)
restorations.ports.security_groups.customer_uuid string (uuid)
restorations.ports.security_groups.customer_name string
restorations.ports.security_groups.customer_native_name string
restorations.ports.security_groups.customer_abbreviation string
restorations.ports.security_groups.error_message string
restorations.ports.security_groups.error_traceback string
restorations.ports.security_groups.resource_type string
restorations.ports.security_groups.state any
restorations.ports.security_groups.created string (date-time)
restorations.ports.security_groups.modified string (date-time)
restorations.ports.security_groups.backend_id string
restorations.ports.security_groups.access_url string
restorations.ports.security_groups.tenant string (uri)
restorations.ports.security_groups.tenant_name string
restorations.ports.security_groups.tenant_uuid string (uuid)
restorations.ports.security_groups.rules array of objects
restorations.ports.security_groups.rules.ethertype any IP protocol version - either 'IPv4' or 'IPv6'
restorations.ports.security_groups.rules.direction any Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing)
restorations.ports.security_groups.rules.protocol any The network protocol (TCP, UDP, ICMP, or empty for any protocol)
restorations.ports.security_groups.rules.from_port integer Starting port number in the range (1-65535)
restorations.ports.security_groups.rules.to_port integer Ending port number in the range (1-65535)
restorations.ports.security_groups.rules.cidr string CIDR notation for the source/destination network address range
restorations.ports.security_groups.rules.description string
restorations.ports.security_groups.rules.remote_group_name string
restorations.ports.security_groups.rules.remote_group_uuid string (uuid)
restorations.ports.security_groups.rules.id integer
restorations.ports.security_groups.rules.remote_group string (uri) Remote security group that this rule references, if any
restorations.ports.security_groups.marketplace_offering_uuid string
restorations.ports.security_groups.marketplace_offering_name string
restorations.ports.security_groups.marketplace_offering_plugin_options object (free-form)
restorations.ports.security_groups.marketplace_category_uuid string
restorations.ports.security_groups.marketplace_category_name string
restorations.ports.security_groups.marketplace_resource_uuid string
restorations.ports.security_groups.marketplace_plan_uuid string
restorations.ports.security_groups.marketplace_resource_state string
restorations.ports.security_groups.is_usage_based boolean
restorations.ports.security_groups.is_limit_based boolean
instance_security_groups array of objects
instance_security_groups.url string (uri)
instance_security_groups.name string
instance_security_groups.rules array of objects
instance_security_groups.rules.ethertype any IP protocol version - either 'IPv4' or 'IPv6'
instance_security_groups.rules.direction any Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing)
instance_security_groups.rules.protocol any The network protocol (TCP, UDP, ICMP, or empty for any protocol)
instance_security_groups.rules.from_port integer Starting port number in the range (1-65535)
instance_security_groups.rules.to_port integer Ending port number in the range (1-65535)
instance_security_groups.rules.cidr string CIDR notation for the source/destination network address range
instance_security_groups.rules.description string
instance_security_groups.rules.remote_group_name string
instance_security_groups.rules.remote_group_uuid string (uuid)
instance_security_groups.rules.id integer
instance_security_groups.description string
instance_security_groups.state string
instance_ports array of objects
instance_ports.url string (uri)
instance_ports.fixed_ips array of objects
instance_ports.fixed_ips.ip_address any IP address to assign to the port
instance_ports.fixed_ips.subnet_id string ID of the subnet in which to assign the IP address
instance_ports.mac_address string MAC address of the port
instance_ports.subnet string (uri) Subnet to which this port belongs
instance_ports.subnet_uuid string (uuid)
instance_ports.subnet_name string
instance_ports.subnet_description string
instance_ports.subnet_cidr string IPv4 network address in CIDR format (e.g. 192.168.0.0/24)
instance_ports.allowed_address_pairs array of objects
instance_ports.allowed_address_pairs.mac_address string
instance_ports.device_id string ID of device (instance, router etc) to which this port is connected
instance_ports.device_owner string Entity that uses this port (e.g. network:router_interface)
instance_ports.security_groups array of objects
instance_ports.security_groups.url string (uri)
instance_ports.security_groups.uuid string (uuid)
instance_ports.security_groups.name string
instance_ports.security_groups.description string
instance_ports.security_groups.service_name string
instance_ports.security_groups.service_settings string (uri)
instance_ports.security_groups.service_settings_uuid string (uuid)
instance_ports.security_groups.service_settings_state string
instance_ports.security_groups.service_settings_error_message string
instance_ports.security_groups.project string (uri)
instance_ports.security_groups.project_name string
instance_ports.security_groups.project_uuid string (uuid)
instance_ports.security_groups.customer string (uri)
instance_ports.security_groups.customer_uuid string (uuid)
instance_ports.security_groups.customer_name string
instance_ports.security_groups.customer_native_name string
instance_ports.security_groups.customer_abbreviation string
instance_ports.security_groups.error_message string
instance_ports.security_groups.error_traceback string
instance_ports.security_groups.resource_type string
instance_ports.security_groups.state any
instance_ports.security_groups.created string (date-time)
instance_ports.security_groups.modified string (date-time)
instance_ports.security_groups.backend_id string
instance_ports.security_groups.access_url string
instance_ports.security_groups.tenant string (uri)
instance_ports.security_groups.tenant_name string
instance_ports.security_groups.tenant_uuid string (uuid)
instance_ports.security_groups.rules array of objects
instance_ports.security_groups.rules.ethertype any IP protocol version - either 'IPv4' or 'IPv6'
instance_ports.security_groups.rules.direction any Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing)
instance_ports.security_groups.rules.protocol any The network protocol (TCP, UDP, ICMP, or empty for any protocol)
instance_ports.security_groups.rules.from_port integer Starting port number in the range (1-65535)
instance_ports.security_groups.rules.to_port integer Ending port number in the range (1-65535)
instance_ports.security_groups.rules.cidr string CIDR notation for the source/destination network address range
instance_ports.security_groups.rules.description string
instance_ports.security_groups.rules.remote_group_name string
instance_ports.security_groups.rules.remote_group_uuid string (uuid)
instance_ports.security_groups.rules.id integer
instance_ports.security_groups.rules.remote_group string (uri) Remote security group that this rule references, if any
instance_ports.security_groups.marketplace_offering_uuid string
instance_ports.security_groups.marketplace_offering_name string
instance_ports.security_groups.marketplace_offering_plugin_options object (free-form)
instance_ports.security_groups.marketplace_category_uuid string
instance_ports.security_groups.marketplace_category_name string
instance_ports.security_groups.marketplace_resource_uuid string
instance_ports.security_groups.marketplace_plan_uuid string
instance_ports.security_groups.marketplace_resource_state string
instance_ports.security_groups.is_usage_based boolean
instance_ports.security_groups.is_limit_based boolean
instance_floating_ips array of objects
instance_floating_ips.url string (uri)
instance_floating_ips.uuid string (uuid)
instance_floating_ips.address any The public IPv4 address of the floating IP
instance_floating_ips.port_fixed_ips array of objects
instance_floating_ips.port_fixed_ips.ip_address any IP address to assign to the port
instance_floating_ips.port_fixed_ips.subnet_id string ID of the subnet in which to assign the IP address
instance_floating_ips.port_mac_address string MAC address of the port
instance_floating_ips.subnet string (uri)
instance_floating_ips.subnet_uuid string (uuid)
instance_floating_ips.subnet_name string
instance_floating_ips.subnet_description string
instance_floating_ips.subnet_cidr string IPv4 network address in CIDR format (e.g. 192.168.0.0/24)
tenant_uuid string (uuid)
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Synchronize resource state

Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.

1
2
3
4
http \
  POST \
  https://api.example.com/api/openstack-backups/a1b2c3d4-e5f6-7890-abcd-ef1234567890/pull/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_backups import openstack_backups_pull # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_backups_pull.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openstack_backups_pull
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackBackupsPull } from 'waldur-js-client';

try {
  const response = await openstackBackupsPull({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

202 -

Field Type
detail string

409 -

Field Type
detail string

Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state.

1
2
3
4
http \
  POST \
  https://api.example.com/api/openstack-backups/a1b2c3d4-e5f6-7890-abcd-ef1234567890/unlink/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_backups import openstack_backups_unlink # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_backups_unlink.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openstack_backups_unlink
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackBackupsUnlink } from 'waldur-js-client';

try {
  const response = await openstackBackupsUnlink({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Update backup

Update an existing instance backup.

1
2
3
4
5
http \
  PUT \
  https://api.example.com/api/openstack-backups/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-openstack-backup"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.open_stack_backup_request import OpenStackBackupRequest # (1)
from waldur_api_client.api.openstack_backups import openstack_backups_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OpenStackBackupRequest(
    name="my-awesome-openstack-backup"
)
response = openstack_backups_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OpenStackBackupRequest
  2. API Source: openstack_backups_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { openstackBackupsUpdate } from 'waldur-js-client';

try {
  const response = await openstackBackupsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-openstack-backup"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
name string ✓
description string
kept_until string (date-time) Guaranteed time of backup retention. If null - keep forever.

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
kept_until string (date-time) Guaranteed time of backup retention. If null - keep forever.
metadata any
instance string (uri) Instance that this backup is created from
instance_name string
instance_marketplace_uuid string (uuid)
restorations array of objects
restorations.uuid string (uuid)
restorations.instance string (uri) Instance that is being restored from the backup
restorations.created string (date-time)
restorations.flavor string (uri) Flavor to be used for the restored instance. If not specified, original instance flavor will be used
restorations.name string New instance name. Leave blank to use source instance name.
restorations.floating_ips array of objects
restorations.floating_ips.url string (uri)
restorations.floating_ips.uuid string (uuid)
restorations.floating_ips.address any The public IPv4 address of the floating IP
restorations.floating_ips.port_fixed_ips array of objects
restorations.floating_ips.port_fixed_ips.ip_address any IP address to assign to the port
restorations.floating_ips.port_fixed_ips.subnet_id string ID of the subnet in which to assign the IP address
restorations.floating_ips.port_mac_address string MAC address of the port
restorations.floating_ips.subnet string (uri)
restorations.floating_ips.subnet_uuid string (uuid)
restorations.floating_ips.subnet_name string
restorations.floating_ips.subnet_description string
restorations.floating_ips.subnet_cidr string IPv4 network address in CIDR format (e.g. 192.168.0.0/24)
restorations.security_groups array of objects
restorations.security_groups.url string (uri)
restorations.security_groups.name string
restorations.security_groups.rules array of objects
restorations.security_groups.rules.ethertype any IP protocol version - either 'IPv4' or 'IPv6'
restorations.security_groups.rules.direction any Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing)
restorations.security_groups.rules.protocol any The network protocol (TCP, UDP, ICMP, or empty for any protocol)
restorations.security_groups.rules.from_port integer Starting port number in the range (1-65535)
restorations.security_groups.rules.to_port integer Ending port number in the range (1-65535)
restorations.security_groups.rules.cidr string CIDR notation for the source/destination network address range
restorations.security_groups.rules.description string
restorations.security_groups.rules.remote_group_name string
restorations.security_groups.rules.remote_group_uuid string (uuid)
restorations.security_groups.rules.id integer
restorations.security_groups.description string
restorations.security_groups.state string
restorations.ports array of objects
restorations.ports.url string (uri)
restorations.ports.fixed_ips array of objects
restorations.ports.fixed_ips.ip_address any IP address to assign to the port
restorations.ports.fixed_ips.subnet_id string ID of the subnet in which to assign the IP address
restorations.ports.mac_address string MAC address of the port
restorations.ports.subnet string (uri) Subnet to which this port belongs
restorations.ports.subnet_uuid string (uuid)
restorations.ports.subnet_name string
restorations.ports.subnet_description string
restorations.ports.subnet_cidr string IPv4 network address in CIDR format (e.g. 192.168.0.0/24)
restorations.ports.allowed_address_pairs array of objects
restorations.ports.allowed_address_pairs.mac_address string
restorations.ports.device_id string ID of device (instance, router etc) to which this port is connected
restorations.ports.device_owner string Entity that uses this port (e.g. network:router_interface)
restorations.ports.security_groups array of objects
restorations.ports.security_groups.url string (uri)
restorations.ports.security_groups.uuid string (uuid)
restorations.ports.security_groups.name string
restorations.ports.security_groups.description string
restorations.ports.security_groups.service_name string
restorations.ports.security_groups.service_settings string (uri)
restorations.ports.security_groups.service_settings_uuid string (uuid)
restorations.ports.security_groups.service_settings_state string
restorations.ports.security_groups.service_settings_error_message string
restorations.ports.security_groups.project string (uri)
restorations.ports.security_groups.project_name string
restorations.ports.security_groups.project_uuid string (uuid)
restorations.ports.security_groups.customer string (uri)
restorations.ports.security_groups.customer_uuid string (uuid)
restorations.ports.security_groups.customer_name string
restorations.ports.security_groups.customer_native_name string
restorations.ports.security_groups.customer_abbreviation string
restorations.ports.security_groups.error_message string
restorations.ports.security_groups.error_traceback string
restorations.ports.security_groups.resource_type string
restorations.ports.security_groups.state any
restorations.ports.security_groups.created string (date-time)
restorations.ports.security_groups.modified string (date-time)
restorations.ports.security_groups.backend_id string
restorations.ports.security_groups.access_url string
restorations.ports.security_groups.tenant string (uri)
restorations.ports.security_groups.tenant_name string
restorations.ports.security_groups.tenant_uuid string (uuid)
restorations.ports.security_groups.rules array of objects
restorations.ports.security_groups.rules.ethertype any IP protocol version - either 'IPv4' or 'IPv6'
restorations.ports.security_groups.rules.direction any Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing)
restorations.ports.security_groups.rules.protocol any The network protocol (TCP, UDP, ICMP, or empty for any protocol)
restorations.ports.security_groups.rules.from_port integer Starting port number in the range (1-65535)
restorations.ports.security_groups.rules.to_port integer Ending port number in the range (1-65535)
restorations.ports.security_groups.rules.cidr string CIDR notation for the source/destination network address range
restorations.ports.security_groups.rules.description string
restorations.ports.security_groups.rules.remote_group_name string
restorations.ports.security_groups.rules.remote_group_uuid string (uuid)
restorations.ports.security_groups.rules.id integer
restorations.ports.security_groups.rules.remote_group string (uri) Remote security group that this rule references, if any
restorations.ports.security_groups.marketplace_offering_uuid string
restorations.ports.security_groups.marketplace_offering_name string
restorations.ports.security_groups.marketplace_offering_plugin_options object (free-form)
restorations.ports.security_groups.marketplace_category_uuid string
restorations.ports.security_groups.marketplace_category_name string
restorations.ports.security_groups.marketplace_resource_uuid string
restorations.ports.security_groups.marketplace_plan_uuid string
restorations.ports.security_groups.marketplace_resource_state string
restorations.ports.security_groups.is_usage_based boolean
restorations.ports.security_groups.is_limit_based boolean
instance_security_groups array of objects
instance_security_groups.url string (uri)
instance_security_groups.name string
instance_security_groups.rules array of objects
instance_security_groups.rules.ethertype any IP protocol version - either 'IPv4' or 'IPv6'
instance_security_groups.rules.direction any Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing)
instance_security_groups.rules.protocol any The network protocol (TCP, UDP, ICMP, or empty for any protocol)
instance_security_groups.rules.from_port integer Starting port number in the range (1-65535)
instance_security_groups.rules.to_port integer Ending port number in the range (1-65535)
instance_security_groups.rules.cidr string CIDR notation for the source/destination network address range
instance_security_groups.rules.description string
instance_security_groups.rules.remote_group_name string
instance_security_groups.rules.remote_group_uuid string (uuid)
instance_security_groups.rules.id integer
instance_security_groups.description string
instance_security_groups.state string
instance_ports array of objects
instance_ports.url string (uri)
instance_ports.fixed_ips array of objects
instance_ports.fixed_ips.ip_address any IP address to assign to the port
instance_ports.fixed_ips.subnet_id string ID of the subnet in which to assign the IP address
instance_ports.mac_address string MAC address of the port
instance_ports.subnet string (uri) Subnet to which this port belongs
instance_ports.subnet_uuid string (uuid)
instance_ports.subnet_name string
instance_ports.subnet_description string
instance_ports.subnet_cidr string IPv4 network address in CIDR format (e.g. 192.168.0.0/24)
instance_ports.allowed_address_pairs array of objects
instance_ports.allowed_address_pairs.mac_address string
instance_ports.device_id string ID of device (instance, router etc) to which this port is connected
instance_ports.device_owner string Entity that uses this port (e.g. network:router_interface)
instance_ports.security_groups array of objects
instance_ports.security_groups.url string (uri)
instance_ports.security_groups.uuid string (uuid)
instance_ports.security_groups.name string
instance_ports.security_groups.description string
instance_ports.security_groups.service_name string
instance_ports.security_groups.service_settings string (uri)
instance_ports.security_groups.service_settings_uuid string (uuid)
instance_ports.security_groups.service_settings_state string
instance_ports.security_groups.service_settings_error_message string
instance_ports.security_groups.project string (uri)
instance_ports.security_groups.project_name string
instance_ports.security_groups.project_uuid string (uuid)
instance_ports.security_groups.customer string (uri)
instance_ports.security_groups.customer_uuid string (uuid)
instance_ports.security_groups.customer_name string
instance_ports.security_groups.customer_native_name string
instance_ports.security_groups.customer_abbreviation string
instance_ports.security_groups.error_message string
instance_ports.security_groups.error_traceback string
instance_ports.security_groups.resource_type string
instance_ports.security_groups.state any
instance_ports.security_groups.created string (date-time)
instance_ports.security_groups.modified string (date-time)
instance_ports.security_groups.backend_id string
instance_ports.security_groups.access_url string
instance_ports.security_groups.tenant string (uri)
instance_ports.security_groups.tenant_name string
instance_ports.security_groups.tenant_uuid string (uuid)
instance_ports.security_groups.rules array of objects
instance_ports.security_groups.rules.ethertype any IP protocol version - either 'IPv4' or 'IPv6'
instance_ports.security_groups.rules.direction any Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing)
instance_ports.security_groups.rules.protocol any The network protocol (TCP, UDP, ICMP, or empty for any protocol)
instance_ports.security_groups.rules.from_port integer Starting port number in the range (1-65535)
instance_ports.security_groups.rules.to_port integer Ending port number in the range (1-65535)
instance_ports.security_groups.rules.cidr string CIDR notation for the source/destination network address range
instance_ports.security_groups.rules.description string
instance_ports.security_groups.rules.remote_group_name string
instance_ports.security_groups.rules.remote_group_uuid string (uuid)
instance_ports.security_groups.rules.id integer
instance_ports.security_groups.rules.remote_group string (uri) Remote security group that this rule references, if any
instance_ports.security_groups.marketplace_offering_uuid string
instance_ports.security_groups.marketplace_offering_name string
instance_ports.security_groups.marketplace_offering_plugin_options object (free-form)
instance_ports.security_groups.marketplace_category_uuid string
instance_ports.security_groups.marketplace_category_name string
instance_ports.security_groups.marketplace_resource_uuid string
instance_ports.security_groups.marketplace_plan_uuid string
instance_ports.security_groups.marketplace_resource_state string
instance_ports.security_groups.is_usage_based boolean
instance_ports.security_groups.is_limit_based boolean
instance_floating_ips array of objects
instance_floating_ips.url string (uri)
instance_floating_ips.uuid string (uuid)
instance_floating_ips.address any The public IPv4 address of the floating IP
instance_floating_ips.port_fixed_ips array of objects
instance_floating_ips.port_fixed_ips.ip_address any IP address to assign to the port
instance_floating_ips.port_fixed_ips.subnet_id string ID of the subnet in which to assign the IP address
instance_floating_ips.port_mac_address string MAC address of the port
instance_floating_ips.subnet string (uri)
instance_floating_ips.subnet_uuid string (uuid)
instance_floating_ips.subnet_name string
instance_floating_ips.subnet_description string
instance_floating_ips.subnet_cidr string IPv4 network address in CIDR format (e.g. 192.168.0.0/24)
tenant_uuid string (uuid)
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Partially update backup

Update specific fields of an instance backup.

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/openstack-backups/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_open_stack_backup_request import PatchedOpenStackBackupRequest # (1)
from waldur_api_client.api.openstack_backups import openstack_backups_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedOpenStackBackupRequest()
response = openstack_backups_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedOpenStackBackupRequest
  2. API Source: openstack_backups_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackBackupsPartialUpdate } from 'waldur-js-client';

try {
  const response = await openstackBackupsPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
name string
description string
kept_until string (date-time) Guaranteed time of backup retention. If null - keep forever.

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
kept_until string (date-time) Guaranteed time of backup retention. If null - keep forever.
metadata any
instance string (uri) Instance that this backup is created from
instance_name string
instance_marketplace_uuid string (uuid)
restorations array of objects
restorations.uuid string (uuid)
restorations.instance string (uri) Instance that is being restored from the backup
restorations.created string (date-time)
restorations.flavor string (uri) Flavor to be used for the restored instance. If not specified, original instance flavor will be used
restorations.name string New instance name. Leave blank to use source instance name.
restorations.floating_ips array of objects
restorations.floating_ips.url string (uri)
restorations.floating_ips.uuid string (uuid)
restorations.floating_ips.address any The public IPv4 address of the floating IP
restorations.floating_ips.port_fixed_ips array of objects
restorations.floating_ips.port_fixed_ips.ip_address any IP address to assign to the port
restorations.floating_ips.port_fixed_ips.subnet_id string ID of the subnet in which to assign the IP address
restorations.floating_ips.port_mac_address string MAC address of the port
restorations.floating_ips.subnet string (uri)
restorations.floating_ips.subnet_uuid string (uuid)
restorations.floating_ips.subnet_name string
restorations.floating_ips.subnet_description string
restorations.floating_ips.subnet_cidr string IPv4 network address in CIDR format (e.g. 192.168.0.0/24)
restorations.security_groups array of objects
restorations.security_groups.url string (uri)
restorations.security_groups.name string
restorations.security_groups.rules array of objects
restorations.security_groups.rules.ethertype any IP protocol version - either 'IPv4' or 'IPv6'
restorations.security_groups.rules.direction any Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing)
restorations.security_groups.rules.protocol any The network protocol (TCP, UDP, ICMP, or empty for any protocol)
restorations.security_groups.rules.from_port integer Starting port number in the range (1-65535)
restorations.security_groups.rules.to_port integer Ending port number in the range (1-65535)
restorations.security_groups.rules.cidr string CIDR notation for the source/destination network address range
restorations.security_groups.rules.description string
restorations.security_groups.rules.remote_group_name string
restorations.security_groups.rules.remote_group_uuid string (uuid)
restorations.security_groups.rules.id integer
restorations.security_groups.description string
restorations.security_groups.state string
restorations.ports array of objects
restorations.ports.url string (uri)
restorations.ports.fixed_ips array of objects
restorations.ports.fixed_ips.ip_address any IP address to assign to the port
restorations.ports.fixed_ips.subnet_id string ID of the subnet in which to assign the IP address
restorations.ports.mac_address string MAC address of the port
restorations.ports.subnet string (uri) Subnet to which this port belongs
restorations.ports.subnet_uuid string (uuid)
restorations.ports.subnet_name string
restorations.ports.subnet_description string
restorations.ports.subnet_cidr string IPv4 network address in CIDR format (e.g. 192.168.0.0/24)
restorations.ports.allowed_address_pairs array of objects
restorations.ports.allowed_address_pairs.mac_address string
restorations.ports.device_id string ID of device (instance, router etc) to which this port is connected
restorations.ports.device_owner string Entity that uses this port (e.g. network:router_interface)
restorations.ports.security_groups array of objects
restorations.ports.security_groups.url string (uri)
restorations.ports.security_groups.uuid string (uuid)
restorations.ports.security_groups.name string
restorations.ports.security_groups.description string
restorations.ports.security_groups.service_name string
restorations.ports.security_groups.service_settings string (uri)
restorations.ports.security_groups.service_settings_uuid string (uuid)
restorations.ports.security_groups.service_settings_state string
restorations.ports.security_groups.service_settings_error_message string
restorations.ports.security_groups.project string (uri)
restorations.ports.security_groups.project_name string
restorations.ports.security_groups.project_uuid string (uuid)
restorations.ports.security_groups.customer string (uri)
restorations.ports.security_groups.customer_uuid string (uuid)
restorations.ports.security_groups.customer_name string
restorations.ports.security_groups.customer_native_name string
restorations.ports.security_groups.customer_abbreviation string
restorations.ports.security_groups.error_message string
restorations.ports.security_groups.error_traceback string
restorations.ports.security_groups.resource_type string
restorations.ports.security_groups.state any
restorations.ports.security_groups.created string (date-time)
restorations.ports.security_groups.modified string (date-time)
restorations.ports.security_groups.backend_id string
restorations.ports.security_groups.access_url string
restorations.ports.security_groups.tenant string (uri)
restorations.ports.security_groups.tenant_name string
restorations.ports.security_groups.tenant_uuid string (uuid)
restorations.ports.security_groups.rules array of objects
restorations.ports.security_groups.rules.ethertype any IP protocol version - either 'IPv4' or 'IPv6'
restorations.ports.security_groups.rules.direction any Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing)
restorations.ports.security_groups.rules.protocol any The network protocol (TCP, UDP, ICMP, or empty for any protocol)
restorations.ports.security_groups.rules.from_port integer Starting port number in the range (1-65535)
restorations.ports.security_groups.rules.to_port integer Ending port number in the range (1-65535)
restorations.ports.security_groups.rules.cidr string CIDR notation for the source/destination network address range
restorations.ports.security_groups.rules.description string
restorations.ports.security_groups.rules.remote_group_name string
restorations.ports.security_groups.rules.remote_group_uuid string (uuid)
restorations.ports.security_groups.rules.id integer
restorations.ports.security_groups.rules.remote_group string (uri) Remote security group that this rule references, if any
restorations.ports.security_groups.marketplace_offering_uuid string
restorations.ports.security_groups.marketplace_offering_name string
restorations.ports.security_groups.marketplace_offering_plugin_options object (free-form)
restorations.ports.security_groups.marketplace_category_uuid string
restorations.ports.security_groups.marketplace_category_name string
restorations.ports.security_groups.marketplace_resource_uuid string
restorations.ports.security_groups.marketplace_plan_uuid string
restorations.ports.security_groups.marketplace_resource_state string
restorations.ports.security_groups.is_usage_based boolean
restorations.ports.security_groups.is_limit_based boolean
instance_security_groups array of objects
instance_security_groups.url string (uri)
instance_security_groups.name string
instance_security_groups.rules array of objects
instance_security_groups.rules.ethertype any IP protocol version - either 'IPv4' or 'IPv6'
instance_security_groups.rules.direction any Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing)
instance_security_groups.rules.protocol any The network protocol (TCP, UDP, ICMP, or empty for any protocol)
instance_security_groups.rules.from_port integer Starting port number in the range (1-65535)
instance_security_groups.rules.to_port integer Ending port number in the range (1-65535)
instance_security_groups.rules.cidr string CIDR notation for the source/destination network address range
instance_security_groups.rules.description string
instance_security_groups.rules.remote_group_name string
instance_security_groups.rules.remote_group_uuid string (uuid)
instance_security_groups.rules.id integer
instance_security_groups.description string
instance_security_groups.state string
instance_ports array of objects
instance_ports.url string (uri)
instance_ports.fixed_ips array of objects
instance_ports.fixed_ips.ip_address any IP address to assign to the port
instance_ports.fixed_ips.subnet_id string ID of the subnet in which to assign the IP address
instance_ports.mac_address string MAC address of the port
instance_ports.subnet string (uri) Subnet to which this port belongs
instance_ports.subnet_uuid string (uuid)
instance_ports.subnet_name string
instance_ports.subnet_description string
instance_ports.subnet_cidr string IPv4 network address in CIDR format (e.g. 192.168.0.0/24)
instance_ports.allowed_address_pairs array of objects
instance_ports.allowed_address_pairs.mac_address string
instance_ports.device_id string ID of device (instance, router etc) to which this port is connected
instance_ports.device_owner string Entity that uses this port (e.g. network:router_interface)
instance_ports.security_groups array of objects
instance_ports.security_groups.url string (uri)
instance_ports.security_groups.uuid string (uuid)
instance_ports.security_groups.name string
instance_ports.security_groups.description string
instance_ports.security_groups.service_name string
instance_ports.security_groups.service_settings string (uri)
instance_ports.security_groups.service_settings_uuid string (uuid)
instance_ports.security_groups.service_settings_state string
instance_ports.security_groups.service_settings_error_message string
instance_ports.security_groups.project string (uri)
instance_ports.security_groups.project_name string
instance_ports.security_groups.project_uuid string (uuid)
instance_ports.security_groups.customer string (uri)
instance_ports.security_groups.customer_uuid string (uuid)
instance_ports.security_groups.customer_name string
instance_ports.security_groups.customer_native_name string
instance_ports.security_groups.customer_abbreviation string
instance_ports.security_groups.error_message string
instance_ports.security_groups.error_traceback string
instance_ports.security_groups.resource_type string
instance_ports.security_groups.state any
instance_ports.security_groups.created string (date-time)
instance_ports.security_groups.modified string (date-time)
instance_ports.security_groups.backend_id string
instance_ports.security_groups.access_url string
instance_ports.security_groups.tenant string (uri)
instance_ports.security_groups.tenant_name string
instance_ports.security_groups.tenant_uuid string (uuid)
instance_ports.security_groups.rules array of objects
instance_ports.security_groups.rules.ethertype any IP protocol version - either 'IPv4' or 'IPv6'
instance_ports.security_groups.rules.direction any Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing)
instance_ports.security_groups.rules.protocol any The network protocol (TCP, UDP, ICMP, or empty for any protocol)
instance_ports.security_groups.rules.from_port integer Starting port number in the range (1-65535)
instance_ports.security_groups.rules.to_port integer Ending port number in the range (1-65535)
instance_ports.security_groups.rules.cidr string CIDR notation for the source/destination network address range
instance_ports.security_groups.rules.description string
instance_ports.security_groups.rules.remote_group_name string
instance_ports.security_groups.rules.remote_group_uuid string (uuid)
instance_ports.security_groups.rules.id integer
instance_ports.security_groups.rules.remote_group string (uri) Remote security group that this rule references, if any
instance_ports.security_groups.marketplace_offering_uuid string
instance_ports.security_groups.marketplace_offering_name string
instance_ports.security_groups.marketplace_offering_plugin_options object (free-form)
instance_ports.security_groups.marketplace_category_uuid string
instance_ports.security_groups.marketplace_category_name string
instance_ports.security_groups.marketplace_resource_uuid string
instance_ports.security_groups.marketplace_plan_uuid string
instance_ports.security_groups.marketplace_resource_state string
instance_ports.security_groups.is_usage_based boolean
instance_ports.security_groups.is_limit_based boolean
instance_floating_ips array of objects
instance_floating_ips.url string (uri)
instance_floating_ips.uuid string (uuid)
instance_floating_ips.address any The public IPv4 address of the floating IP
instance_floating_ips.port_fixed_ips array of objects
instance_floating_ips.port_fixed_ips.ip_address any IP address to assign to the port
instance_floating_ips.port_fixed_ips.subnet_id string ID of the subnet in which to assign the IP address
instance_floating_ips.port_mac_address string MAC address of the port
instance_floating_ips.subnet string (uri)
instance_floating_ips.subnet_uuid string (uuid)
instance_floating_ips.subnet_name string
instance_floating_ips.subnet_description string
instance_floating_ips.subnet_cidr string IPv4 network address in CIDR format (e.g. 192.168.0.0/24)
tenant_uuid string (uuid)
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Delete backup

Delete an instance backup.

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/openstack-backups/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_backups import openstack_backups_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_backups_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openstack_backups_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackBackupsDestroy } from 'waldur-js-client';

try {
  const response = await openstackBackupsDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Other Actions

Restore instance from backup

Restore instance from backup

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/openstack-backups/a1b2c3d4-e5f6-7890-abcd-ef1234567890/restore/ \
  Authorization:"Token YOUR_API_TOKEN" \
  flavor="https://api.example.com/api/flavor/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.open_stack_backup_restoration_create_request import OpenStackBackupRestorationCreateRequest # (1)
from waldur_api_client.api.openstack_backups import openstack_backups_restore # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OpenStackBackupRestorationCreateRequest(
    flavor="https://api.example.com/api/flavor/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = openstack_backups_restore.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OpenStackBackupRestorationCreateRequest
  2. API Source: openstack_backups_restore
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { openstackBackupsRestore } from 'waldur-js-client';

try {
  const response = await openstackBackupsRestore({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "flavor": "https://api.example.com/api/flavor/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
flavor string (uri) ✓ Flavor to be used for the restored instance. If not specified, original instance flavor will be used
name string New instance name. Leave blank to use source instance name.
floating_ips array of objects Floating IPs that will be assigned to the restored instance
floating_ips.url string (uri)
floating_ips.ip_address any Existing floating IP address in selected OpenStack tenant to be assigned to new virtual machine
floating_ips.subnet string (uri) ✓
security_groups array of objects Security groups that will be assigned to the restored instance
security_groups.url string (uri) ✓
ports array of objects Network ports that will be attached to the restored instance
ports.fixed_ips array of objects
ports.fixed_ips.ip_address any ✓ IP address to assign to the port
ports.fixed_ips.subnet_id string ✓ ID of the subnet in which to assign the IP address
ports.subnet string (uri) Subnet to which this port belongs
ports.port string (uri)
ports.tenant string (uri) Target tenant for port creation. If not specified, uses subnet's tenant.
Constraints: write-only

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri) OpenStack provider settings
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string Instance ID in the OpenStack backend
access_url string
start_time string (date-time)
cores integer Number of cores in a VM
ram integer Memory size in MiB
disk integer Disk size in MiB
min_ram integer Minimum memory size in MiB
min_disk integer Minimum disk size in MiB
user_data string Additional data that will be added to instance on provisioning
external_ips array of string (ipv4)s
internal_ips array of string (ipv4)s
latitude number (double)
longitude number (double)
key_name string
key_fingerprint string
image_name string
flavor_disk integer Flavor disk size in MiB
flavor_name string Name of the flavor used by this instance
volumes array of objects List of volumes attached to the instance
volumes.url string (uri)
volumes.uuid string (uuid)
volumes.name string
volumes.image_name string Name of the image this volume was created from
volumes.state string
volumes.bootable boolean Indicates if this volume can be used to boot an instance
volumes.size integer Size in MiB
volumes.device string Name of volume as instance device e.g. /dev/vdb.
volumes.resource_type string
volumes.type string (uri) Type of the volume (e.g. SSD, HDD)
volumes.type_name string
volumes.marketplace_resource_uuid string
security_groups array of objects
security_groups.url string (uri)
security_groups.name string
security_groups.rules array of objects
security_groups.rules.ethertype any IP protocol version - either 'IPv4' or 'IPv6'
security_groups.rules.direction any Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing)
security_groups.rules.protocol any The network protocol (TCP, UDP, ICMP, or empty for any protocol)
security_groups.rules.from_port integer Starting port number in the range (1-65535)
security_groups.rules.to_port integer Ending port number in the range (1-65535)
security_groups.rules.cidr string CIDR notation for the source/destination network address range
security_groups.rules.description string
security_groups.rules.remote_group_name string
security_groups.rules.remote_group_uuid string (uuid)
security_groups.rules.id integer
security_groups.description string
security_groups.state string
server_group object
server_group.url string (uri)
server_group.name string
server_group.policy any Server group policy determining the rules for scheduling servers in this group
server_group.state string
floating_ips array of objects
floating_ips.url string (uri)
floating_ips.uuid string (uuid)
floating_ips.address any The public IPv4 address of the floating IP
floating_ips.port_fixed_ips array of objects
floating_ips.port_fixed_ips.ip_address any IP address to assign to the port
floating_ips.port_fixed_ips.subnet_id string ID of the subnet in which to assign the IP address
floating_ips.port_mac_address string MAC address of the port
floating_ips.subnet string (uri)
floating_ips.subnet_uuid string (uuid)
floating_ips.subnet_name string
floating_ips.subnet_description string
floating_ips.subnet_cidr string IPv4 network address in CIDR format (e.g. 192.168.0.0/24)
ports array of objects
ports.url string (uri)
ports.fixed_ips array of objects
ports.fixed_ips.ip_address any IP address to assign to the port
ports.fixed_ips.subnet_id string ID of the subnet in which to assign the IP address
ports.mac_address string MAC address of the port
ports.subnet string (uri) Subnet to which this port belongs
ports.subnet_uuid string (uuid)
ports.subnet_name string
ports.subnet_description string
ports.subnet_cidr string IPv4 network address in CIDR format (e.g. 192.168.0.0/24)
ports.allowed_address_pairs array of objects
ports.allowed_address_pairs.mac_address string
ports.device_id string ID of device (instance, router etc) to which this port is connected
ports.device_owner string Entity that uses this port (e.g. network:router_interface)
ports.security_groups array of objects
ports.security_groups.url string (uri)
ports.security_groups.uuid string (uuid)
ports.security_groups.name string
ports.security_groups.description string
ports.security_groups.service_name string
ports.security_groups.service_settings string (uri)
ports.security_groups.service_settings_uuid string (uuid)
ports.security_groups.service_settings_state string
ports.security_groups.service_settings_error_message string
ports.security_groups.project string (uri)
ports.security_groups.project_name string
ports.security_groups.project_uuid string (uuid)
ports.security_groups.customer string (uri)
ports.security_groups.customer_uuid string (uuid)
ports.security_groups.customer_name string
ports.security_groups.customer_native_name string
ports.security_groups.customer_abbreviation string
ports.security_groups.error_message string
ports.security_groups.error_traceback string
ports.security_groups.resource_type string
ports.security_groups.state any
ports.security_groups.created string (date-time)
ports.security_groups.modified string (date-time)
ports.security_groups.backend_id string
ports.security_groups.access_url string
ports.security_groups.tenant string (uri)
ports.security_groups.tenant_name string
ports.security_groups.tenant_uuid string (uuid)
ports.security_groups.rules array of objects
ports.security_groups.rules.ethertype any IP protocol version - either 'IPv4' or 'IPv6'
ports.security_groups.rules.direction any Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing)
ports.security_groups.rules.protocol any The network protocol (TCP, UDP, ICMP, or empty for any protocol)
ports.security_groups.rules.from_port integer Starting port number in the range (1-65535)
ports.security_groups.rules.to_port integer Ending port number in the range (1-65535)
ports.security_groups.rules.cidr string CIDR notation for the source/destination network address range
ports.security_groups.rules.description string
ports.security_groups.rules.remote_group_name string
ports.security_groups.rules.remote_group_uuid string (uuid)
ports.security_groups.rules.id integer
ports.security_groups.rules.remote_group string (uri) Remote security group that this rule references, if any
ports.security_groups.marketplace_offering_uuid string
ports.security_groups.marketplace_offering_name string
ports.security_groups.marketplace_offering_plugin_options object (free-form)
ports.security_groups.marketplace_category_uuid string
ports.security_groups.marketplace_category_name string
ports.security_groups.marketplace_resource_uuid string
ports.security_groups.marketplace_plan_uuid string
ports.security_groups.marketplace_resource_state string
ports.security_groups.is_usage_based boolean
ports.security_groups.is_limit_based boolean
availability_zone string (uri) Availability zone where this instance is located
availability_zone_name string Name of the availability zone where instance is located
connect_directly_to_external_network boolean If True, instance will be connected directly to external network
runtime_state string
action string
action_details any Details about ongoing or completed actions
tenant_uuid string (uuid) UUID of the OpenStack tenant
hypervisor_hostname string Name of the hypervisor hosting this instance
tenant string (uri) The OpenStack tenant to create the instance in
external_address array of strings
rancher_cluster any
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Mark resource as ERRED

Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.

1
2
3
4
http \
  POST \
  https://api.example.com/api/openstack-backups/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_erred/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.set_erred_request import SetErredRequest # (1)
from waldur_api_client.api.openstack_backups import openstack_backups_set_erred # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = SetErredRequest()
response = openstack_backups_set_erred.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: SetErredRequest
  2. API Source: openstack_backups_set_erred
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackBackupsSetErred } from 'waldur-js-client';

try {
  const response = await openstackBackupsSetErred({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
error_message string
error_traceback string

200 -

Field Type
detail string

Mark resource as OK

Manually transition the resource to OK state and clear error fields. Staff-only operation.

1
2
3
4
http \
  POST \
  https://api.example.com/api/openstack-backups/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_ok/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_backups import openstack_backups_set_ok # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_backups_set_ok.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openstack_backups_set_ok
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackBackupsSetOk } from 'waldur-js-client';

try {
  const response = await openstackBackupsSetOk({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
detail string

Openstack External Networks

Operations Summary

Method Endpoint Description
GET /api/openstack-external-networks/ List external networks
GET /api/openstack-external-networks/{uuid}/ Get external network details

List external networks

Get a list of provider-level external networks discovered from OpenStack.

1
2
3
4
http \
  GET \
  https://api.example.com/api/openstack-external-networks/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.external_network_field_enum import ExternalNetworkFieldEnum # (1)
from waldur_api_client.api.openstack_external_networks import openstack_external_networks_list # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_external_networks_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: ExternalNetworkFieldEnum
  2. API Source: openstack_external_networks_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { openstackExternalNetworksList } from 'waldur-js-client';

try {
  const response = await openstackExternalNetworksList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
field array
name string Name
name_exact string Name (exact)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
settings string (uri) Settings URL
settings_uuid string (uuid) Settings UUID

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
name string
settings string (uri)
backend_id string
is_shared boolean
is_default boolean
status string
description string
subnets array of objects
subnets.uuid string (uuid)
subnets.name string
subnets.backend_id string
subnets.cidr string
subnets.gateway_ip any An IPv4 or IPv6 address.
subnets.ip_version integer
subnets.enable_dhcp boolean
subnets.allocation_pools any
subnets.dns_nameservers any
subnets.public_ip_range string Public CIDR mapped to this subnet (for carrier-grade NAT overlay)
subnets.description string

Get external network details

Retrieve details of a specific external network, including its subnets.

1
2
3
4
http \
  GET \
  https://api.example.com/api/openstack-external-networks/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.external_network_field_enum import ExternalNetworkFieldEnum # (1)
from waldur_api_client.api.openstack_external_networks import openstack_external_networks_retrieve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_external_networks_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. Model Source: ExternalNetworkFieldEnum
  2. API Source: openstack_external_networks_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackExternalNetworksRetrieve } from 'waldur-js-client';

try {
  const response = await openstackExternalNetworksRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type
field array

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
settings string (uri)
backend_id string
is_shared boolean
is_default boolean
status string
description string
subnets array of objects
subnets.uuid string (uuid)
subnets.name string
subnets.backend_id string
subnets.cidr string
subnets.gateway_ip any An IPv4 or IPv6 address.
subnets.ip_version integer
subnets.enable_dhcp boolean
subnets.allocation_pools any
subnets.dns_nameservers any
subnets.public_ip_range string Public CIDR mapped to this subnet (for carrier-grade NAT overlay)
subnets.description string

Openstack Flavors

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/openstack-flavors/ List flavors
GET /api/openstack-flavors/{uuid}/ Get flavor details
Other Actions
GET /api/openstack-flavors/usage_stats/ Get flavor usage statistics

Core CRUD

List flavors

Get a list of available VM instance flavors.

1
2
3
4
http \
  GET \
  https://api.example.com/api/openstack-flavors/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.open_stack_flavor_field_enum import OpenStackFlavorFieldEnum # (1)
from waldur_api_client.models.open_stack_flavor_o_enum import OpenStackFlavorOEnum # (2)
from waldur_api_client.api.openstack_flavors import openstack_flavors_list # (3)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_flavors_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: OpenStackFlavorFieldEnum
  2. Model Source: OpenStackFlavorOEnum
  3. API Source: openstack_flavors_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { openstackFlavorsList } from 'waldur-js-client';

try {
  const response = await openstackFlavorsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
cores integer
cores__gte integer
cores__lte integer
disk integer
disk__gte integer
disk__lte integer
field array
name string Name
name_exact string Name (exact)
name_iregex string Name (regex)
o array Ordering
offering_uuid string (uuid) Offering UUID
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
ram integer
ram__gte integer
ram__lte integer
settings string (uri) Settings URL
settings_uuid string (uuid) Settings UUID
tenant string (uri) Tenant URL
tenant_uuid string (uuid) Tenant UUID

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
name string
settings string (uri)
cores integer Number of cores in a VM
ram integer Memory size in MiB
disk integer Root disk size in MiB
backend_id string
display_name string

Get flavor details

Retrieve details of a specific VM instance flavor.

1
2
3
4
http \
  GET \
  https://api.example.com/api/openstack-flavors/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.open_stack_flavor_field_enum import OpenStackFlavorFieldEnum # (1)
from waldur_api_client.api.openstack_flavors import openstack_flavors_retrieve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_flavors_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. Model Source: OpenStackFlavorFieldEnum
  2. API Source: openstack_flavors_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackFlavorsRetrieve } from 'waldur-js-client';

try {
  const response = await openstackFlavorsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type
field array

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
settings string (uri)
cores integer Number of cores in a VM
ram integer Memory size in MiB
disk integer Root disk size in MiB
backend_id string
display_name string

Other Actions

Get flavor usage statistics

Retrieve usage statistics for VM instance flavors, showing running and created instance counts for each flavor.

1
2
3
4
http \
  GET \
  https://api.example.com/api/openstack-flavors/usage_stats/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.open_stack_flavor_field_enum import OpenStackFlavorFieldEnum # (1)
from waldur_api_client.api.openstack_flavors import openstack_flavors_usage_stats_retrieve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_flavors_usage_stats_retrieve.sync(client=client)

print(response)
  1. Model Source: OpenStackFlavorFieldEnum
  2. API Source: openstack_flavors_usage_stats_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { openstackFlavorsUsageStatsRetrieve } from 'waldur-js-client';

try {
  const response = await openstackFlavorsUsageStatsRetrieve({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type
field array

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
settings string (uri)
cores integer Number of cores in a VM
ram integer Memory size in MiB
disk integer Root disk size in MiB
backend_id string
display_name string

Openstack Floating Ips

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/openstack-floating-ips/ List floating IPs
GET /api/openstack-floating-ips/{uuid}/ Get floating IP details
POST /api/openstack-floating-ips/{uuid}/pull/ Synchronize resource state
POST /api/openstack-floating-ips/{uuid}/unlink/ Unlink resource
POST /api/openstack-floating-ips/{uuid}/update_description/ Update floating IP description
DELETE /api/openstack-floating-ips/{uuid}/ Delete floating IP
Other Actions
POST /api/openstack-floating-ips/{uuid}/attach_to_port/ Attach floating IP to a port
POST /api/openstack-floating-ips/{uuid}/detach_from_port/ Detach floating IP from port
POST /api/openstack-floating-ips/{uuid}/set_erred/ Mark resource as ERRED
POST /api/openstack-floating-ips/{uuid}/set_ok/ Mark resource as OK

Core CRUD

List floating IPs

Get a list of floating IP addresses. Status DOWN means that floating IP is not linked to a VM, status ACTIVE means that it is in use.

1
2
3
4
http \
  GET \
  https://api.example.com/api/openstack-floating-ips/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.core_states import CoreStates # (1)
from waldur_api_client.models.open_stack_floating_ip_field_enum import OpenStackFloatingIPFieldEnum # (2)
from waldur_api_client.api.openstack_floating_ips import openstack_floating_ips_list # (3)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_floating_ips_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: CoreStates
  2. Model Source: OpenStackFloatingIPFieldEnum
  3. API Source: openstack_floating_ips_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { openstackFloatingIpsList } from 'waldur-js-client';

try {
  const response = await openstackFloatingIpsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
address string
backend_id string Backend ID
can_manage boolean Can manage
customer string (uuid) Customer UUID
customer_abbreviation string Customer abbreviation
customer_name string Customer name
customer_native_name string Customer native name
customer_uuid string (uuid) Customer UUID
description string Description
external_ip string External IP
field array
free boolean Is free
name string Name
name_exact string Name (exact)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
project string (uuid) Project UUID
project_name string Project name
project_uuid string (uuid) Project UUID
runtime_state string
service_settings_name string Service settings name
service_settings_uuid string (uuid) Service settings UUID
state array State
tenant string (uri) Tenant URL
tenant_uuid string (uuid) Tenant UUID
uuid string (uuid) UUID

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
runtime_state string
address any The public IPv4 address of the floating IP
backend_network_id string ID of network in OpenStack where this floating IP is allocated
tenant string (uri) OpenStack tenant this floating IP belongs to
tenant_name string
tenant_uuid string (uuid)
port string (uri)
external_address any Optional address that maps to floating IP's address in external networks
port_fixed_ips array of objects
port_fixed_ips.ip_address any IP address to assign to the port
port_fixed_ips.subnet_id string ID of the subnet in which to assign the IP address
instance_uuid string
instance_name string
instance_url string
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Get floating IP details

Retrieve details of a specific floating IP address.

1
2
3
4
http \
  GET \
  https://api.example.com/api/openstack-floating-ips/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.open_stack_floating_ip_field_enum import OpenStackFloatingIPFieldEnum # (1)
from waldur_api_client.api.openstack_floating_ips import openstack_floating_ips_retrieve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_floating_ips_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. Model Source: OpenStackFloatingIPFieldEnum
  2. API Source: openstack_floating_ips_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackFloatingIpsRetrieve } from 'waldur-js-client';

try {
  const response = await openstackFloatingIpsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type
field array

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
runtime_state string
address any The public IPv4 address of the floating IP
backend_network_id string ID of network in OpenStack where this floating IP is allocated
tenant string (uri) OpenStack tenant this floating IP belongs to
tenant_name string
tenant_uuid string (uuid)
port string (uri)
external_address any Optional address that maps to floating IP's address in external networks
port_fixed_ips array of objects
port_fixed_ips.ip_address any IP address to assign to the port
port_fixed_ips.subnet_id string ID of the subnet in which to assign the IP address
instance_uuid string
instance_name string
instance_url string
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Synchronize resource state

Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.

1
2
3
4
http \
  POST \
  https://api.example.com/api/openstack-floating-ips/a1b2c3d4-e5f6-7890-abcd-ef1234567890/pull/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_floating_ips import openstack_floating_ips_pull # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_floating_ips_pull.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openstack_floating_ips_pull
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackFloatingIpsPull } from 'waldur-js-client';

try {
  const response = await openstackFloatingIpsPull({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

202 -

Field Type
detail string

409 -

Field Type
detail string

Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state.

1
2
3
4
http \
  POST \
  https://api.example.com/api/openstack-floating-ips/a1b2c3d4-e5f6-7890-abcd-ef1234567890/unlink/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_floating_ips import openstack_floating_ips_unlink # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_floating_ips_unlink.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openstack_floating_ips_unlink
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackFloatingIpsUnlink } from 'waldur-js-client';

try {
  const response = await openstackFloatingIpsUnlink({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Update floating IP description

Update description of the floating IP

1
2
3
4
http \
  POST \
  https://api.example.com/api/openstack-floating-ips/a1b2c3d4-e5f6-7890-abcd-ef1234567890/update_description/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.open_stack_floating_ip_description_update_request import OpenStackFloatingIPDescriptionUpdateRequest # (1)
from waldur_api_client.api.openstack_floating_ips import openstack_floating_ips_update_description # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OpenStackFloatingIPDescriptionUpdateRequest()
response = openstack_floating_ips_update_description.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OpenStackFloatingIPDescriptionUpdateRequest
  2. API Source: openstack_floating_ips_update_description
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackFloatingIpsUpdateDescription } from 'waldur-js-client';

try {
  const response = await openstackFloatingIpsUpdateDescription({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
description string New floating IP description.

200 - No response body

Delete floating IP

Delete a floating IP address.

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/openstack-floating-ips/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_floating_ips import openstack_floating_ips_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_floating_ips_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openstack_floating_ips_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackFloatingIpsDestroy } from 'waldur-js-client';

try {
  const response = await openstackFloatingIpsDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Other Actions

Attach floating IP to a port

Attach floating IP to port

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/openstack-floating-ips/a1b2c3d4-e5f6-7890-abcd-ef1234567890/attach_to_port/ \
  Authorization:"Token YOUR_API_TOKEN" \
  port="https://api.example.com/api/port/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.open_stack_floating_ip_attach_request import OpenStackFloatingIPAttachRequest # (1)
from waldur_api_client.api.openstack_floating_ips import openstack_floating_ips_attach_to_port # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OpenStackFloatingIPAttachRequest(
    port="https://api.example.com/api/port/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = openstack_floating_ips_attach_to_port.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OpenStackFloatingIPAttachRequest
  2. API Source: openstack_floating_ips_attach_to_port
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { openstackFloatingIpsAttachToPort } from 'waldur-js-client';

try {
  const response = await openstackFloatingIpsAttachToPort({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "port": "https://api.example.com/api/port/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
port string (uri) ✓

200 - No response body

Detach floating IP from port

Detach floating IP from port

1
2
3
4
http \
  POST \
  https://api.example.com/api/openstack-floating-ips/a1b2c3d4-e5f6-7890-abcd-ef1234567890/detach_from_port/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_floating_ips import openstack_floating_ips_detach_from_port # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_floating_ips_detach_from_port.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openstack_floating_ips_detach_from_port
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackFloatingIpsDetachFromPort } from 'waldur-js-client';

try {
  const response = await openstackFloatingIpsDetachFromPort({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 - No response body

Mark resource as ERRED

Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.

1
2
3
4
http \
  POST \
  https://api.example.com/api/openstack-floating-ips/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_erred/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.set_erred_request import SetErredRequest # (1)
from waldur_api_client.api.openstack_floating_ips import openstack_floating_ips_set_erred # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = SetErredRequest()
response = openstack_floating_ips_set_erred.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: SetErredRequest
  2. API Source: openstack_floating_ips_set_erred
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackFloatingIpsSetErred } from 'waldur-js-client';

try {
  const response = await openstackFloatingIpsSetErred({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
error_message string
error_traceback string

200 -

Field Type
detail string

Mark resource as OK

Manually transition the resource to OK state and clear error fields. Staff-only operation.

1
2
3
4
http \
  POST \
  https://api.example.com/api/openstack-floating-ips/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_ok/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_floating_ips import openstack_floating_ips_set_ok # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_floating_ips_set_ok.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openstack_floating_ips_set_ok
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackFloatingIpsSetOk } from 'waldur-js-client';

try {
  const response = await openstackFloatingIpsSetOk({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
detail string

Openstack Images

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/openstack-images/ List images
GET /api/openstack-images/{uuid}/ Get image details
Other Actions
GET /api/openstack-images/usage_stats/ Get image usage statistics

Core CRUD

List images

Get a list of available VM instance images.

1
2
3
4
http \
  GET \
  https://api.example.com/api/openstack-images/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_images import openstack_images_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_images_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: openstack_images_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { openstackImagesList } from 'waldur-js-client';

try {
  const response = await openstackImagesList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
name string Name
name_exact string Name (exact)
offering_uuid string (uuid) Offering UUID
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
settings string (uri) Settings URL
settings_uuid string (uuid) Settings UUID
show_duplicate_names boolean Show duplicate image names
tenant string (uri) Tenant URL
tenant_uuid string (uuid) Tenant UUID

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
name string
min_disk integer Minimum disk size in MiB
min_ram integer Minimum memory size in MiB
settings string (uri)
backend_id string
backend_created_at string (date-time)

Get image details

Retrieve details of a specific VM instance image.

1
2
3
4
http \
  GET \
  https://api.example.com/api/openstack-images/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_images import openstack_images_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_images_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openstack_images_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackImagesRetrieve } from 'waldur-js-client';

try {
  const response = await openstackImagesRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
min_disk integer Minimum disk size in MiB
min_ram integer Minimum memory size in MiB
settings string (uri)
backend_id string
backend_created_at string (date-time)

Other Actions

Get image usage statistics

Retrieve usage statistics for VM instance images, showing running and created instance counts for each image.

1
2
3
4
http \
  GET \
  https://api.example.com/api/openstack-images/usage_stats/ \
  Authorization:"Token YOUR_API_TOKEN"

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_images import openstack_images_usage_stats_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_images_usage_stats_retrieve.sync(client=client)

print(response)
  1. API Source: openstack_images_usage_stats_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { openstackImagesUsageStatsRetrieve } from 'waldur-js-client';

try {
  const response = await openstackImagesUsageStatsRetrieve({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
min_disk integer Minimum disk size in MiB
min_ram integer Minimum memory size in MiB
settings string (uri)
backend_id string
backend_created_at string (date-time)

Openstack Instance Availability Zones

Operations Summary

Method Endpoint Description
GET /api/openstack-instance-availability-zones/ List instance availability zones
GET /api/openstack-instance-availability-zones/{uuid}/ Get instance availability zone details

List instance availability zones

Get a list of instance availability zones.

1
2
3
4
http \
  GET \
  https://api.example.com/api/openstack-instance-availability-zones/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_instance_availability_zones import openstack_instance_availability_zones_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_instance_availability_zones_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: openstack_instance_availability_zones_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { openstackInstanceAvailabilityZonesList } from 'waldur-js-client';

try {
  const response = await openstackInstanceAvailabilityZonesList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
name string Name
name_exact string Name (exact)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
settings string (uri) Settings URL
settings_uuid string (uuid) Settings UUID
tenant string (uri) Tenant URL
tenant_uuid string (uuid) Tenant UUID

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
name string
settings string (uri)
available boolean Indicates whether this availability zone is available for instance provisioning

Get instance availability zone details

Retrieve details of a specific instance availability zone.

1
2
3
4
http \
  GET \
  https://api.example.com/api/openstack-instance-availability-zones/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_instance_availability_zones import openstack_instance_availability_zones_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_instance_availability_zones_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openstack_instance_availability_zones_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackInstanceAvailabilityZonesRetrieve } from 'waldur-js-client';

try {
  const response = await openstackInstanceAvailabilityZonesRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
settings string (uri)
available boolean Indicates whether this availability zone is available for instance provisioning

Openstack Instances

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/openstack-instances/ List instances
GET /api/openstack-instances/{uuid}/ Get instance details
POST /api/openstack-instances/{uuid}/pull/ Synchronize resource state
POST /api/openstack-instances/{uuid}/unlink/ Unlink resource
PUT /api/openstack-instances/{uuid}/ Update instance
PATCH /api/openstack-instances/{uuid}/ Partially update instance
State Management
POST /api/openstack-instances/{uuid}/restart/ Restart instance
POST /api/openstack-instances/{uuid}/start/ Start instance
POST /api/openstack-instances/{uuid}/stop/ Stop instance
Subresource Management
GET /api/openstack-instances/{uuid}/console_log/ Get console log
GET /api/openstack-instances/{uuid}/console/ Get console URL
GET /api/openstack-instances/{uuid}/floating_ips/ List instance floating IPs
GET /api/openstack-instances/{uuid}/ports/ List instance ports
POST /api/openstack-instances/{uuid}/backup/ Create instance backup
POST /api/openstack-instances/{uuid}/update_allowed_address_pairs/ Update instance allowed address pairs
POST /api/openstack-instances/{uuid}/update_floating_ips/ Update instance floating IPs
POST /api/openstack-instances/{uuid}/update_ports/ Update instance ports
POST /api/openstack-instances/{uuid}/update_security_groups/ Update instance security groups
Other Actions
POST /api/openstack-instances/{uuid}/change_flavor/ Change instance flavor
POST /api/openstack-instances/{uuid}/set_erred/ Mark resource as ERRED
POST /api/openstack-instances/{uuid}/set_ok/ Mark resource as OK

Core CRUD

List instances

Get a list of VM instances.

1
2
3
4
http \
  GET \
  https://api.example.com/api/openstack-instances/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.core_states import CoreStates # (1)
from waldur_api_client.models.open_stack_instance_field_enum import OpenStackInstanceFieldEnum # (2)
from waldur_api_client.models.open_stack_instance_o_enum import OpenStackInstanceOEnum # (3)
from waldur_api_client.api.openstack_instances import openstack_instances_list # (4)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_instances_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: CoreStates
  2. Model Source: OpenStackInstanceFieldEnum
  3. Model Source: OpenStackInstanceOEnum
  4. API Source: openstack_instances_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { openstackInstancesList } from 'waldur-js-client';

try {
  const response = await openstackInstancesList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
attach_volume_uuid string (uuid) Filter for attachment to volume UUID
availability_zone_name string Availability zone name
backend_id string Backend ID
can_manage boolean Can manage
customer string (uuid) Customer UUID
customer_abbreviation string Customer abbreviation
customer_name string Customer name
customer_native_name string Customer native name
customer_uuid string (uuid) Customer UUID
description string Description
external_ip string External IP
field array
name string Name
name_exact string Name (exact)
o string Ordering. Sort by start time.
Enum: start_time, -start_time
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
project string (uuid) Project UUID
project_name string Project name
project_uuid string (uuid) Project UUID
query string Search by name, internal IP, or external IP
runtime_state string
service_settings_name string Service settings name
service_settings_uuid string (uuid) Service settings UUID
state array State
tenant string (uri) Tenant URL
tenant_uuid string (uuid) Tenant UUID
uuid string (uuid) UUID

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri) OpenStack provider settings
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string Instance ID in the OpenStack backend
access_url string
start_time string (date-time)
cores integer Number of cores in a VM
ram integer Memory size in MiB
disk integer Disk size in MiB
min_ram integer Minimum memory size in MiB
min_disk integer Minimum disk size in MiB
user_data string Additional data that will be added to instance on provisioning
external_ips array of string (ipv4)s
internal_ips array of string (ipv4)s
latitude number (double)
longitude number (double)
key_name string
key_fingerprint string
image_name string
flavor_disk integer Flavor disk size in MiB
flavor_name string Name of the flavor used by this instance
volumes array of objects List of volumes attached to the instance
volumes.url string (uri)
volumes.uuid string (uuid)
volumes.name string
volumes.image_name string Name of the image this volume was created from
volumes.state string
volumes.bootable boolean Indicates if this volume can be used to boot an instance
volumes.size integer Size in MiB
volumes.device string Name of volume as instance device e.g. /dev/vdb.
volumes.resource_type string
volumes.type string (uri) Type of the volume (e.g. SSD, HDD)
volumes.type_name string
volumes.marketplace_resource_uuid string
security_groups array of objects
security_groups.url string (uri)
security_groups.name string
security_groups.rules array of objects
security_groups.rules.ethertype any IP protocol version - either 'IPv4' or 'IPv6'
security_groups.rules.direction any Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing)
security_groups.rules.protocol any The network protocol (TCP, UDP, ICMP, or empty for any protocol)
security_groups.rules.from_port integer Starting port number in the range (1-65535)
security_groups.rules.to_port integer Ending port number in the range (1-65535)
security_groups.rules.cidr string CIDR notation for the source/destination network address range
security_groups.rules.description string
security_groups.rules.remote_group_name string
security_groups.rules.remote_group_uuid string (uuid)
security_groups.rules.id integer
security_groups.description string
security_groups.state string
server_group object
server_group.url string (uri)
server_group.name string
server_group.policy any Server group policy determining the rules for scheduling servers in this group
server_group.state string
floating_ips array of objects
floating_ips.url string (uri)
floating_ips.uuid string (uuid)
floating_ips.address any The public IPv4 address of the floating IP
floating_ips.port_fixed_ips array of objects
floating_ips.port_fixed_ips.ip_address any IP address to assign to the port
floating_ips.port_fixed_ips.subnet_id string ID of the subnet in which to assign the IP address
floating_ips.port_mac_address string MAC address of the port
floating_ips.subnet string (uri)
floating_ips.subnet_uuid string (uuid)
floating_ips.subnet_name string
floating_ips.subnet_description string
floating_ips.subnet_cidr string IPv4 network address in CIDR format (e.g. 192.168.0.0/24)
ports array of objects
ports.url string (uri)
ports.fixed_ips array of objects
ports.fixed_ips.ip_address any IP address to assign to the port
ports.fixed_ips.subnet_id string ID of the subnet in which to assign the IP address
ports.mac_address string MAC address of the port
ports.subnet string (uri) Subnet to which this port belongs
ports.subnet_uuid string (uuid)
ports.subnet_name string
ports.subnet_description string
ports.subnet_cidr string IPv4 network address in CIDR format (e.g. 192.168.0.0/24)
ports.allowed_address_pairs array of objects
ports.allowed_address_pairs.mac_address string
ports.device_id string ID of device (instance, router etc) to which this port is connected
ports.device_owner string Entity that uses this port (e.g. network:router_interface)
ports.security_groups array of objects
ports.security_groups.url string (uri)
ports.security_groups.uuid string (uuid)
ports.security_groups.name string
ports.security_groups.description string
ports.security_groups.service_name string
ports.security_groups.service_settings string (uri)
ports.security_groups.service_settings_uuid string (uuid)
ports.security_groups.service_settings_state string
ports.security_groups.service_settings_error_message string
ports.security_groups.project string (uri)
ports.security_groups.project_name string
ports.security_groups.project_uuid string (uuid)
ports.security_groups.customer string (uri)
ports.security_groups.customer_uuid string (uuid)
ports.security_groups.customer_name string
ports.security_groups.customer_native_name string
ports.security_groups.customer_abbreviation string
ports.security_groups.error_message string
ports.security_groups.error_traceback string
ports.security_groups.resource_type string
ports.security_groups.state any
ports.security_groups.created string (date-time)
ports.security_groups.modified string (date-time)
ports.security_groups.backend_id string
ports.security_groups.access_url string
ports.security_groups.tenant string (uri)
ports.security_groups.tenant_name string
ports.security_groups.tenant_uuid string (uuid)
ports.security_groups.rules array of objects
ports.security_groups.rules.ethertype any IP protocol version - either 'IPv4' or 'IPv6'
ports.security_groups.rules.direction any Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing)
ports.security_groups.rules.protocol any The network protocol (TCP, UDP, ICMP, or empty for any protocol)
ports.security_groups.rules.from_port integer Starting port number in the range (1-65535)
ports.security_groups.rules.to_port integer Ending port number in the range (1-65535)
ports.security_groups.rules.cidr string CIDR notation for the source/destination network address range
ports.security_groups.rules.description string
ports.security_groups.rules.remote_group_name string
ports.security_groups.rules.remote_group_uuid string (uuid)
ports.security_groups.rules.id integer
ports.security_groups.rules.remote_group string (uri) Remote security group that this rule references, if any
ports.security_groups.marketplace_offering_uuid string
ports.security_groups.marketplace_offering_name string
ports.security_groups.marketplace_offering_plugin_options object (free-form)
ports.security_groups.marketplace_category_uuid string
ports.security_groups.marketplace_category_name string
ports.security_groups.marketplace_resource_uuid string
ports.security_groups.marketplace_plan_uuid string
ports.security_groups.marketplace_resource_state string
ports.security_groups.is_usage_based boolean
ports.security_groups.is_limit_based boolean
availability_zone string (uri) Availability zone where this instance is located
availability_zone_name string Name of the availability zone where instance is located
connect_directly_to_external_network boolean If True, instance will be connected directly to external network
runtime_state string
action string
action_details any Details about ongoing or completed actions
tenant_uuid string (uuid) UUID of the OpenStack tenant
hypervisor_hostname string Name of the hypervisor hosting this instance
tenant string (uri) The OpenStack tenant to create the instance in
external_address array of strings
rancher_cluster any
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Get instance details

Retrieve details of a specific VM instance.

1
2
3
4
http \
  GET \
  https://api.example.com/api/openstack-instances/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.open_stack_instance_field_enum import OpenStackInstanceFieldEnum # (1)
from waldur_api_client.api.openstack_instances import openstack_instances_retrieve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_instances_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. Model Source: OpenStackInstanceFieldEnum
  2. API Source: openstack_instances_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackInstancesRetrieve } from 'waldur-js-client';

try {
  const response = await openstackInstancesRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type
field array

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri) OpenStack provider settings
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string Instance ID in the OpenStack backend
access_url string
start_time string (date-time)
cores integer Number of cores in a VM
ram integer Memory size in MiB
disk integer Disk size in MiB
min_ram integer Minimum memory size in MiB
min_disk integer Minimum disk size in MiB
user_data string Additional data that will be added to instance on provisioning
external_ips array of string (ipv4)s
internal_ips array of string (ipv4)s
latitude number (double)
longitude number (double)
key_name string
key_fingerprint string
image_name string
flavor_disk integer Flavor disk size in MiB
flavor_name string Name of the flavor used by this instance
volumes array of objects List of volumes attached to the instance
volumes.url string (uri)
volumes.uuid string (uuid)
volumes.name string
volumes.image_name string Name of the image this volume was created from
volumes.state string
volumes.bootable boolean Indicates if this volume can be used to boot an instance
volumes.size integer Size in MiB
volumes.device string Name of volume as instance device e.g. /dev/vdb.
volumes.resource_type string
volumes.type string (uri) Type of the volume (e.g. SSD, HDD)
volumes.type_name string
volumes.marketplace_resource_uuid string
security_groups array of objects
security_groups.url string (uri)
security_groups.name string
security_groups.rules array of objects
security_groups.rules.ethertype any IP protocol version - either 'IPv4' or 'IPv6'
security_groups.rules.direction any Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing)
security_groups.rules.protocol any The network protocol (TCP, UDP, ICMP, or empty for any protocol)
security_groups.rules.from_port integer Starting port number in the range (1-65535)
security_groups.rules.to_port integer Ending port number in the range (1-65535)
security_groups.rules.cidr string CIDR notation for the source/destination network address range
security_groups.rules.description string
security_groups.rules.remote_group_name string
security_groups.rules.remote_group_uuid string (uuid)
security_groups.rules.id integer
security_groups.description string
security_groups.state string
server_group object
server_group.url string (uri)
server_group.name string
server_group.policy any Server group policy determining the rules for scheduling servers in this group
server_group.state string
floating_ips array of objects
floating_ips.url string (uri)
floating_ips.uuid string (uuid)
floating_ips.address any The public IPv4 address of the floating IP
floating_ips.port_fixed_ips array of objects
floating_ips.port_fixed_ips.ip_address any IP address to assign to the port
floating_ips.port_fixed_ips.subnet_id string ID of the subnet in which to assign the IP address
floating_ips.port_mac_address string MAC address of the port
floating_ips.subnet string (uri)
floating_ips.subnet_uuid string (uuid)
floating_ips.subnet_name string
floating_ips.subnet_description string
floating_ips.subnet_cidr string IPv4 network address in CIDR format (e.g. 192.168.0.0/24)
ports array of objects
ports.url string (uri)
ports.fixed_ips array of objects
ports.fixed_ips.ip_address any IP address to assign to the port
ports.fixed_ips.subnet_id string ID of the subnet in which to assign the IP address
ports.mac_address string MAC address of the port
ports.subnet string (uri) Subnet to which this port belongs
ports.subnet_uuid string (uuid)
ports.subnet_name string
ports.subnet_description string
ports.subnet_cidr string IPv4 network address in CIDR format (e.g. 192.168.0.0/24)
ports.allowed_address_pairs array of objects
ports.allowed_address_pairs.mac_address string
ports.device_id string ID of device (instance, router etc) to which this port is connected
ports.device_owner string Entity that uses this port (e.g. network:router_interface)
ports.security_groups array of objects
ports.security_groups.url string (uri)
ports.security_groups.uuid string (uuid)
ports.security_groups.name string
ports.security_groups.description string
ports.security_groups.service_name string
ports.security_groups.service_settings string (uri)
ports.security_groups.service_settings_uuid string (uuid)
ports.security_groups.service_settings_state string
ports.security_groups.service_settings_error_message string
ports.security_groups.project string (uri)
ports.security_groups.project_name string
ports.security_groups.project_uuid string (uuid)
ports.security_groups.customer string (uri)
ports.security_groups.customer_uuid string (uuid)
ports.security_groups.customer_name string
ports.security_groups.customer_native_name string
ports.security_groups.customer_abbreviation string
ports.security_groups.error_message string
ports.security_groups.error_traceback string
ports.security_groups.resource_type string
ports.security_groups.state any
ports.security_groups.created string (date-time)
ports.security_groups.modified string (date-time)
ports.security_groups.backend_id string
ports.security_groups.access_url string
ports.security_groups.tenant string (uri)
ports.security_groups.tenant_name string
ports.security_groups.tenant_uuid string (uuid)
ports.security_groups.rules array of objects
ports.security_groups.rules.ethertype any IP protocol version - either 'IPv4' or 'IPv6'
ports.security_groups.rules.direction any Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing)
ports.security_groups.rules.protocol any The network protocol (TCP, UDP, ICMP, or empty for any protocol)
ports.security_groups.rules.from_port integer Starting port number in the range (1-65535)
ports.security_groups.rules.to_port integer Ending port number in the range (1-65535)
ports.security_groups.rules.cidr string CIDR notation for the source/destination network address range
ports.security_groups.rules.description string
ports.security_groups.rules.remote_group_name string
ports.security_groups.rules.remote_group_uuid string (uuid)
ports.security_groups.rules.id integer
ports.security_groups.rules.remote_group string (uri) Remote security group that this rule references, if any
ports.security_groups.marketplace_offering_uuid string
ports.security_groups.marketplace_offering_name string
ports.security_groups.marketplace_offering_plugin_options object (free-form)
ports.security_groups.marketplace_category_uuid string
ports.security_groups.marketplace_category_name string
ports.security_groups.marketplace_resource_uuid string
ports.security_groups.marketplace_plan_uuid string
ports.security_groups.marketplace_resource_state string
ports.security_groups.is_usage_based boolean
ports.security_groups.is_limit_based boolean
availability_zone string (uri) Availability zone where this instance is located
availability_zone_name string Name of the availability zone where instance is located
connect_directly_to_external_network boolean If True, instance will be connected directly to external network
runtime_state string
action string
action_details any Details about ongoing or completed actions
tenant_uuid string (uuid) UUID of the OpenStack tenant
hypervisor_hostname string Name of the hypervisor hosting this instance
tenant string (uri) The OpenStack tenant to create the instance in
external_address array of strings
rancher_cluster any
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Synchronize resource state

Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.

1
2
3
4
http \
  POST \
  https://api.example.com/api/openstack-instances/a1b2c3d4-e5f6-7890-abcd-ef1234567890/pull/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_instances import openstack_instances_pull # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_instances_pull.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openstack_instances_pull
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackInstancesPull } from 'waldur-js-client';

try {
  const response = await openstackInstancesPull({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

202 -

Field Type
detail string

409 -

Field Type
detail string

Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state.

1
2
3
4
http \
  POST \
  https://api.example.com/api/openstack-instances/a1b2c3d4-e5f6-7890-abcd-ef1234567890/unlink/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_instances import openstack_instances_unlink # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_instances_unlink.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openstack_instances_unlink
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackInstancesUnlink } from 'waldur-js-client';

try {
  const response = await openstackInstancesUnlink({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Update instance

Update an existing VM instance.

1
2
3
4
5
http \
  PUT \
  https://api.example.com/api/openstack-instances/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-openstack-instance"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.open_stack_instance_request import OpenStackInstanceRequest # (1)
from waldur_api_client.api.openstack_instances import openstack_instances_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OpenStackInstanceRequest(
    name="my-awesome-openstack-instance"
)
response = openstack_instances_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OpenStackInstanceRequest
  2. API Source: openstack_instances_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { openstackInstancesUpdate } from 'waldur-js-client';

try {
  const response = await openstackInstancesUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-openstack-instance"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
name string ✓
description string

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri) OpenStack provider settings
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string Instance ID in the OpenStack backend
access_url string
start_time string (date-time)
cores integer Number of cores in a VM
ram integer Memory size in MiB
disk integer Disk size in MiB
min_ram integer Minimum memory size in MiB
min_disk integer Minimum disk size in MiB
user_data string Additional data that will be added to instance on provisioning
external_ips array of string (ipv4)s
internal_ips array of string (ipv4)s
latitude number (double)
longitude number (double)
key_name string
key_fingerprint string
image_name string
flavor_disk integer Flavor disk size in MiB
flavor_name string Name of the flavor used by this instance
volumes array of objects List of volumes attached to the instance
volumes.url string (uri)
volumes.uuid string (uuid)
volumes.name string
volumes.image_name string Name of the image this volume was created from
volumes.state string
volumes.bootable boolean Indicates if this volume can be used to boot an instance
volumes.size integer Size in MiB
volumes.device string Name of volume as instance device e.g. /dev/vdb.
volumes.resource_type string
volumes.type string (uri) Type of the volume (e.g. SSD, HDD)
volumes.type_name string
volumes.marketplace_resource_uuid string
security_groups array of objects
security_groups.url string (uri)
security_groups.name string
security_groups.rules array of objects
security_groups.rules.ethertype any IP protocol version - either 'IPv4' or 'IPv6'
security_groups.rules.direction any Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing)
security_groups.rules.protocol any The network protocol (TCP, UDP, ICMP, or empty for any protocol)
security_groups.rules.from_port integer Starting port number in the range (1-65535)
security_groups.rules.to_port integer Ending port number in the range (1-65535)
security_groups.rules.cidr string CIDR notation for the source/destination network address range
security_groups.rules.description string
security_groups.rules.remote_group_name string
security_groups.rules.remote_group_uuid string (uuid)
security_groups.rules.id integer
security_groups.description string
security_groups.state string
server_group object
server_group.url string (uri)
server_group.name string
server_group.policy any Server group policy determining the rules for scheduling servers in this group
server_group.state string
floating_ips array of objects
floating_ips.url string (uri)
floating_ips.uuid string (uuid)
floating_ips.address any The public IPv4 address of the floating IP
floating_ips.port_fixed_ips array of objects
floating_ips.port_fixed_ips.ip_address any IP address to assign to the port
floating_ips.port_fixed_ips.subnet_id string ID of the subnet in which to assign the IP address
floating_ips.port_mac_address string MAC address of the port
floating_ips.subnet string (uri)
floating_ips.subnet_uuid string (uuid)
floating_ips.subnet_name string
floating_ips.subnet_description string
floating_ips.subnet_cidr string IPv4 network address in CIDR format (e.g. 192.168.0.0/24)
ports array of objects
ports.url string (uri)
ports.fixed_ips array of objects
ports.fixed_ips.ip_address any IP address to assign to the port
ports.fixed_ips.subnet_id string ID of the subnet in which to assign the IP address
ports.mac_address string MAC address of the port
ports.subnet string (uri) Subnet to which this port belongs
ports.subnet_uuid string (uuid)
ports.subnet_name string
ports.subnet_description string
ports.subnet_cidr string IPv4 network address in CIDR format (e.g. 192.168.0.0/24)
ports.allowed_address_pairs array of objects
ports.allowed_address_pairs.mac_address string
ports.device_id string ID of device (instance, router etc) to which this port is connected
ports.device_owner string Entity that uses this port (e.g. network:router_interface)
ports.security_groups array of objects
ports.security_groups.url string (uri)
ports.security_groups.uuid string (uuid)
ports.security_groups.name string
ports.security_groups.description string
ports.security_groups.service_name string
ports.security_groups.service_settings string (uri)
ports.security_groups.service_settings_uuid string (uuid)
ports.security_groups.service_settings_state string
ports.security_groups.service_settings_error_message string
ports.security_groups.project string (uri)
ports.security_groups.project_name string
ports.security_groups.project_uuid string (uuid)
ports.security_groups.customer string (uri)
ports.security_groups.customer_uuid string (uuid)
ports.security_groups.customer_name string
ports.security_groups.customer_native_name string
ports.security_groups.customer_abbreviation string
ports.security_groups.error_message string
ports.security_groups.error_traceback string
ports.security_groups.resource_type string
ports.security_groups.state any
ports.security_groups.created string (date-time)
ports.security_groups.modified string (date-time)
ports.security_groups.backend_id string
ports.security_groups.access_url string
ports.security_groups.tenant string (uri)
ports.security_groups.tenant_name string
ports.security_groups.tenant_uuid string (uuid)
ports.security_groups.rules array of objects
ports.security_groups.rules.ethertype any IP protocol version - either 'IPv4' or 'IPv6'
ports.security_groups.rules.direction any Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing)
ports.security_groups.rules.protocol any The network protocol (TCP, UDP, ICMP, or empty for any protocol)
ports.security_groups.rules.from_port integer Starting port number in the range (1-65535)
ports.security_groups.rules.to_port integer Ending port number in the range (1-65535)
ports.security_groups.rules.cidr string CIDR notation for the source/destination network address range
ports.security_groups.rules.description string
ports.security_groups.rules.remote_group_name string
ports.security_groups.rules.remote_group_uuid string (uuid)
ports.security_groups.rules.id integer
ports.security_groups.rules.remote_group string (uri) Remote security group that this rule references, if any
ports.security_groups.marketplace_offering_uuid string
ports.security_groups.marketplace_offering_name string
ports.security_groups.marketplace_offering_plugin_options object (free-form)
ports.security_groups.marketplace_category_uuid string
ports.security_groups.marketplace_category_name string
ports.security_groups.marketplace_resource_uuid string
ports.security_groups.marketplace_plan_uuid string
ports.security_groups.marketplace_resource_state string
ports.security_groups.is_usage_based boolean
ports.security_groups.is_limit_based boolean
availability_zone string (uri) Availability zone where this instance is located
availability_zone_name string Name of the availability zone where instance is located
connect_directly_to_external_network boolean If True, instance will be connected directly to external network
runtime_state string
action string
action_details any Details about ongoing or completed actions
tenant_uuid string (uuid) UUID of the OpenStack tenant
hypervisor_hostname string Name of the hypervisor hosting this instance
tenant string (uri) The OpenStack tenant to create the instance in
external_address array of strings
rancher_cluster any
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Partially update instance

Update specific fields of a VM instance.

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/openstack-instances/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_open_stack_instance_request import PatchedOpenStackInstanceRequest # (1)
from waldur_api_client.api.openstack_instances import openstack_instances_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedOpenStackInstanceRequest()
response = openstack_instances_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedOpenStackInstanceRequest
  2. API Source: openstack_instances_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackInstancesPartialUpdate } from 'waldur-js-client';

try {
  const response = await openstackInstancesPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
name string
description string

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri) OpenStack provider settings
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string Instance ID in the OpenStack backend
access_url string
start_time string (date-time)
cores integer Number of cores in a VM
ram integer Memory size in MiB
disk integer Disk size in MiB
min_ram integer Minimum memory size in MiB
min_disk integer Minimum disk size in MiB
user_data string Additional data that will be added to instance on provisioning
external_ips array of string (ipv4)s
internal_ips array of string (ipv4)s
latitude number (double)
longitude number (double)
key_name string
key_fingerprint string
image_name string
flavor_disk integer Flavor disk size in MiB
flavor_name string Name of the flavor used by this instance
volumes array of objects List of volumes attached to the instance
volumes.url string (uri)
volumes.uuid string (uuid)
volumes.name string
volumes.image_name string Name of the image this volume was created from
volumes.state string
volumes.bootable boolean Indicates if this volume can be used to boot an instance
volumes.size integer Size in MiB
volumes.device string Name of volume as instance device e.g. /dev/vdb.
volumes.resource_type string
volumes.type string (uri) Type of the volume (e.g. SSD, HDD)
volumes.type_name string
volumes.marketplace_resource_uuid string
security_groups array of objects
security_groups.url string (uri)
security_groups.name string
security_groups.rules array of objects
security_groups.rules.ethertype any IP protocol version - either 'IPv4' or 'IPv6'
security_groups.rules.direction any Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing)
security_groups.rules.protocol any The network protocol (TCP, UDP, ICMP, or empty for any protocol)
security_groups.rules.from_port integer Starting port number in the range (1-65535)
security_groups.rules.to_port integer Ending port number in the range (1-65535)
security_groups.rules.cidr string CIDR notation for the source/destination network address range
security_groups.rules.description string
security_groups.rules.remote_group_name string
security_groups.rules.remote_group_uuid string (uuid)
security_groups.rules.id integer
security_groups.description string
security_groups.state string
server_group object
server_group.url string (uri)
server_group.name string
server_group.policy any Server group policy determining the rules for scheduling servers in this group
server_group.state string
floating_ips array of objects
floating_ips.url string (uri)
floating_ips.uuid string (uuid)
floating_ips.address any The public IPv4 address of the floating IP
floating_ips.port_fixed_ips array of objects
floating_ips.port_fixed_ips.ip_address any IP address to assign to the port
floating_ips.port_fixed_ips.subnet_id string ID of the subnet in which to assign the IP address
floating_ips.port_mac_address string MAC address of the port
floating_ips.subnet string (uri)
floating_ips.subnet_uuid string (uuid)
floating_ips.subnet_name string
floating_ips.subnet_description string
floating_ips.subnet_cidr string IPv4 network address in CIDR format (e.g. 192.168.0.0/24)
ports array of objects
ports.url string (uri)
ports.fixed_ips array of objects
ports.fixed_ips.ip_address any IP address to assign to the port
ports.fixed_ips.subnet_id string ID of the subnet in which to assign the IP address
ports.mac_address string MAC address of the port
ports.subnet string (uri) Subnet to which this port belongs
ports.subnet_uuid string (uuid)
ports.subnet_name string
ports.subnet_description string
ports.subnet_cidr string IPv4 network address in CIDR format (e.g. 192.168.0.0/24)
ports.allowed_address_pairs array of objects
ports.allowed_address_pairs.mac_address string
ports.device_id string ID of device (instance, router etc) to which this port is connected
ports.device_owner string Entity that uses this port (e.g. network:router_interface)
ports.security_groups array of objects
ports.security_groups.url string (uri)
ports.security_groups.uuid string (uuid)
ports.security_groups.name string
ports.security_groups.description string
ports.security_groups.service_name string
ports.security_groups.service_settings string (uri)
ports.security_groups.service_settings_uuid string (uuid)
ports.security_groups.service_settings_state string
ports.security_groups.service_settings_error_message string
ports.security_groups.project string (uri)
ports.security_groups.project_name string
ports.security_groups.project_uuid string (uuid)
ports.security_groups.customer string (uri)
ports.security_groups.customer_uuid string (uuid)
ports.security_groups.customer_name string
ports.security_groups.customer_native_name string
ports.security_groups.customer_abbreviation string
ports.security_groups.error_message string
ports.security_groups.error_traceback string
ports.security_groups.resource_type string
ports.security_groups.state any
ports.security_groups.created string (date-time)
ports.security_groups.modified string (date-time)
ports.security_groups.backend_id string
ports.security_groups.access_url string
ports.security_groups.tenant string (uri)
ports.security_groups.tenant_name string
ports.security_groups.tenant_uuid string (uuid)
ports.security_groups.rules array of objects
ports.security_groups.rules.ethertype any IP protocol version - either 'IPv4' or 'IPv6'
ports.security_groups.rules.direction any Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing)
ports.security_groups.rules.protocol any The network protocol (TCP, UDP, ICMP, or empty for any protocol)
ports.security_groups.rules.from_port integer Starting port number in the range (1-65535)
ports.security_groups.rules.to_port integer Ending port number in the range (1-65535)
ports.security_groups.rules.cidr string CIDR notation for the source/destination network address range
ports.security_groups.rules.description string
ports.security_groups.rules.remote_group_name string
ports.security_groups.rules.remote_group_uuid string (uuid)
ports.security_groups.rules.id integer
ports.security_groups.rules.remote_group string (uri) Remote security group that this rule references, if any
ports.security_groups.marketplace_offering_uuid string
ports.security_groups.marketplace_offering_name string
ports.security_groups.marketplace_offering_plugin_options object (free-form)
ports.security_groups.marketplace_category_uuid string
ports.security_groups.marketplace_category_name string
ports.security_groups.marketplace_resource_uuid string
ports.security_groups.marketplace_plan_uuid string
ports.security_groups.marketplace_resource_state string
ports.security_groups.is_usage_based boolean
ports.security_groups.is_limit_based boolean
availability_zone string (uri) Availability zone where this instance is located
availability_zone_name string Name of the availability zone where instance is located
connect_directly_to_external_network boolean If True, instance will be connected directly to external network
runtime_state string
action string
action_details any Details about ongoing or completed actions
tenant_uuid string (uuid) UUID of the OpenStack tenant
hypervisor_hostname string Name of the hypervisor hosting this instance
tenant string (uri) The OpenStack tenant to create the instance in
external_address array of strings
rancher_cluster any
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

State Management

Restart instance

Restart the instance

1
2
3
4
http \
  POST \
  https://api.example.com/api/openstack-instances/a1b2c3d4-e5f6-7890-abcd-ef1234567890/restart/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_instances import openstack_instances_restart # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_instances_restart.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openstack_instances_restart
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackInstancesRestart } from 'waldur-js-client';

try {
  const response = await openstackInstancesRestart({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 - No response body

Start instance

Start the instance

1
2
3
4
http \
  POST \
  https://api.example.com/api/openstack-instances/a1b2c3d4-e5f6-7890-abcd-ef1234567890/start/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_instances import openstack_instances_start # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_instances_start.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openstack_instances_start
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackInstancesStart } from 'waldur-js-client';

try {
  const response = await openstackInstancesStart({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 - No response body

Stop instance

Stop the instance

1
2
3
4
http \
  POST \
  https://api.example.com/api/openstack-instances/a1b2c3d4-e5f6-7890-abcd-ef1234567890/stop/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_instances import openstack_instances_stop # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_instances_stop.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openstack_instances_stop
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackInstancesStop } from 'waldur-js-client';

try {
  const response = await openstackInstancesStop({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 - No response body

Subresource Management

Get console log

Get console log for the instance

1
2
3
4
http \
  GET \
  https://api.example.com/api/openstack-instances/a1b2c3d4-e5f6-7890-abcd-ef1234567890/console_log/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_instances import openstack_instances_console_log_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_instances_console_log_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openstack_instances_console_log_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackInstancesConsoleLogRetrieve } from 'waldur-js-client';

try {
  const response = await openstackInstancesConsoleLogRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type
length integer

200 -

Get console URL

Get console url for the instance

1
2
3
4
http \
  GET \
  https://api.example.com/api/openstack-instances/a1b2c3d4-e5f6-7890-abcd-ef1234567890/console/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_instances import openstack_instances_console_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_instances_console_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openstack_instances_console_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackInstancesConsoleRetrieve } from 'waldur-js-client';

try {
  const response = await openstackInstancesConsoleRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
url string (uri)

List instance floating IPs

Get a list of instance floating IPs

1
2
3
4
http \
  GET \
  https://api.example.com/api/openstack-instances/a1b2c3d4-e5f6-7890-abcd-ef1234567890/floating_ips/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_instances import openstack_instances_floating_ips_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_instances_floating_ips_list.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

for item in response:
    print(item)
  1. API Source: openstack_instances_floating_ips_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackInstancesFloatingIpsList } from 'waldur-js-client';

try {
  const response = await openstackInstancesFloatingIpsList({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
address any The public IPv4 address of the floating IP
port_fixed_ips array of objects
port_fixed_ips.ip_address any IP address to assign to the port
port_fixed_ips.subnet_id string ID of the subnet in which to assign the IP address
port_mac_address string MAC address of the port
subnet string (uri)
subnet_uuid string (uuid)
subnet_name string
subnet_description string
subnet_cidr string IPv4 network address in CIDR format (e.g. 192.168.0.0/24)

List instance ports

Get a list of instance ports

1
2
3
4
http \
  GET \
  https://api.example.com/api/openstack-instances/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ports/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_instances import openstack_instances_ports_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_instances_ports_list.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

for item in response:
    print(item)
  1. API Source: openstack_instances_ports_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackInstancesPortsList } from 'waldur-js-client';

try {
  const response = await openstackInstancesPortsList({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
fixed_ips array of objects
fixed_ips.ip_address any IP address to assign to the port
fixed_ips.subnet_id string ID of the subnet in which to assign the IP address
mac_address string MAC address of the port
subnet string (uri) Subnet to which this port belongs
subnet_uuid string (uuid)
subnet_name string
subnet_description string
subnet_cidr string IPv4 network address in CIDR format (e.g. 192.168.0.0/24)
allowed_address_pairs array of objects
allowed_address_pairs.mac_address string
device_id string ID of device (instance, router etc) to which this port is connected
device_owner string Entity that uses this port (e.g. network:router_interface)
security_groups array of objects
security_groups.url string (uri)
security_groups.uuid string (uuid)
security_groups.name string
security_groups.description string
security_groups.service_name string
security_groups.service_settings string (uri)
security_groups.service_settings_uuid string (uuid)
security_groups.service_settings_state string
security_groups.service_settings_error_message string
security_groups.project string (uri)
security_groups.project_name string
security_groups.project_uuid string (uuid)
security_groups.customer string (uri)
security_groups.customer_uuid string (uuid)
security_groups.customer_name string
security_groups.customer_native_name string
security_groups.customer_abbreviation string
security_groups.error_message string
security_groups.error_traceback string
security_groups.resource_type string
security_groups.state any
security_groups.created string (date-time)
security_groups.modified string (date-time)
security_groups.backend_id string
security_groups.access_url string
security_groups.tenant string (uri)
security_groups.tenant_name string
security_groups.tenant_uuid string (uuid)
security_groups.rules array of objects
security_groups.rules.ethertype any IP protocol version - either 'IPv4' or 'IPv6'
security_groups.rules.direction any Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing)
security_groups.rules.protocol any The network protocol (TCP, UDP, ICMP, or empty for any protocol)
security_groups.rules.from_port integer Starting port number in the range (1-65535)
security_groups.rules.to_port integer Ending port number in the range (1-65535)
security_groups.rules.cidr string CIDR notation for the source/destination network address range
security_groups.rules.description string
security_groups.rules.remote_group_name string
security_groups.rules.remote_group_uuid string (uuid)
security_groups.rules.id integer
security_groups.rules.remote_group string (uri) Remote security group that this rule references, if any
security_groups.marketplace_offering_uuid string
security_groups.marketplace_offering_name string
security_groups.marketplace_offering_plugin_options object (free-form)
security_groups.marketplace_category_uuid string
security_groups.marketplace_category_name string
security_groups.marketplace_resource_uuid string
security_groups.marketplace_plan_uuid string
security_groups.marketplace_resource_state string
security_groups.is_usage_based boolean
security_groups.is_limit_based boolean

Create instance backup

Create backup from instance

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/openstack-instances/a1b2c3d4-e5f6-7890-abcd-ef1234567890/backup/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-openstack-instance"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.open_stack_backup_request import OpenStackBackupRequest # (1)
from waldur_api_client.api.openstack_instances import openstack_instances_backup # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OpenStackBackupRequest(
    name="my-awesome-openstack-instance"
)
response = openstack_instances_backup.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OpenStackBackupRequest
  2. API Source: openstack_instances_backup
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { openstackInstancesBackup } from 'waldur-js-client';

try {
  const response = await openstackInstancesBackup({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-openstack-instance"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
name string ✓
description string
kept_until string (date-time) Guaranteed time of backup retention. If null - keep forever.

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
kept_until string (date-time) Guaranteed time of backup retention. If null - keep forever.
metadata any
instance string (uri) Instance that this backup is created from
instance_name string
instance_marketplace_uuid string (uuid)
restorations array of objects
restorations.uuid string (uuid)
restorations.instance string (uri) Instance that is being restored from the backup
restorations.created string (date-time)
restorations.flavor string (uri) Flavor to be used for the restored instance. If not specified, original instance flavor will be used
restorations.name string New instance name. Leave blank to use source instance name.
restorations.floating_ips array of objects
restorations.floating_ips.url string (uri)
restorations.floating_ips.uuid string (uuid)
restorations.floating_ips.address any The public IPv4 address of the floating IP
restorations.floating_ips.port_fixed_ips array of objects
restorations.floating_ips.port_fixed_ips.ip_address any IP address to assign to the port
restorations.floating_ips.port_fixed_ips.subnet_id string ID of the subnet in which to assign the IP address
restorations.floating_ips.port_mac_address string MAC address of the port
restorations.floating_ips.subnet string (uri)
restorations.floating_ips.subnet_uuid string (uuid)
restorations.floating_ips.subnet_name string
restorations.floating_ips.subnet_description string
restorations.floating_ips.subnet_cidr string IPv4 network address in CIDR format (e.g. 192.168.0.0/24)
restorations.security_groups array of objects
restorations.security_groups.url string (uri)
restorations.security_groups.name string
restorations.security_groups.rules array of objects
restorations.security_groups.rules.ethertype any IP protocol version - either 'IPv4' or 'IPv6'
restorations.security_groups.rules.direction any Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing)
restorations.security_groups.rules.protocol any The network protocol (TCP, UDP, ICMP, or empty for any protocol)
restorations.security_groups.rules.from_port integer Starting port number in the range (1-65535)
restorations.security_groups.rules.to_port integer Ending port number in the range (1-65535)
restorations.security_groups.rules.cidr string CIDR notation for the source/destination network address range
restorations.security_groups.rules.description string
restorations.security_groups.rules.remote_group_name string
restorations.security_groups.rules.remote_group_uuid string (uuid)
restorations.security_groups.rules.id integer
restorations.security_groups.description string
restorations.security_groups.state string
restorations.ports array of objects
restorations.ports.url string (uri)
restorations.ports.fixed_ips array of objects
restorations.ports.fixed_ips.ip_address any IP address to assign to the port
restorations.ports.fixed_ips.subnet_id string ID of the subnet in which to assign the IP address
restorations.ports.mac_address string MAC address of the port
restorations.ports.subnet string (uri) Subnet to which this port belongs
restorations.ports.subnet_uuid string (uuid)
restorations.ports.subnet_name string
restorations.ports.subnet_description string
restorations.ports.subnet_cidr string IPv4 network address in CIDR format (e.g. 192.168.0.0/24)
restorations.ports.allowed_address_pairs array of objects
restorations.ports.allowed_address_pairs.mac_address string
restorations.ports.device_id string ID of device (instance, router etc) to which this port is connected
restorations.ports.device_owner string Entity that uses this port (e.g. network:router_interface)
restorations.ports.security_groups array of objects
restorations.ports.security_groups.url string (uri)
restorations.ports.security_groups.uuid string (uuid)
restorations.ports.security_groups.name string
restorations.ports.security_groups.description string
restorations.ports.security_groups.service_name string
restorations.ports.security_groups.service_settings string (uri)
restorations.ports.security_groups.service_settings_uuid string (uuid)
restorations.ports.security_groups.service_settings_state string
restorations.ports.security_groups.service_settings_error_message string
restorations.ports.security_groups.project string (uri)
restorations.ports.security_groups.project_name string
restorations.ports.security_groups.project_uuid string (uuid)
restorations.ports.security_groups.customer string (uri)
restorations.ports.security_groups.customer_uuid string (uuid)
restorations.ports.security_groups.customer_name string
restorations.ports.security_groups.customer_native_name string
restorations.ports.security_groups.customer_abbreviation string
restorations.ports.security_groups.error_message string
restorations.ports.security_groups.error_traceback string
restorations.ports.security_groups.resource_type string
restorations.ports.security_groups.state any
restorations.ports.security_groups.created string (date-time)
restorations.ports.security_groups.modified string (date-time)
restorations.ports.security_groups.backend_id string
restorations.ports.security_groups.access_url string
restorations.ports.security_groups.tenant string (uri)
restorations.ports.security_groups.tenant_name string
restorations.ports.security_groups.tenant_uuid string (uuid)
restorations.ports.security_groups.rules array of objects
restorations.ports.security_groups.rules.ethertype any IP protocol version - either 'IPv4' or 'IPv6'
restorations.ports.security_groups.rules.direction any Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing)
restorations.ports.security_groups.rules.protocol any The network protocol (TCP, UDP, ICMP, or empty for any protocol)
restorations.ports.security_groups.rules.from_port integer Starting port number in the range (1-65535)
restorations.ports.security_groups.rules.to_port integer Ending port number in the range (1-65535)
restorations.ports.security_groups.rules.cidr string CIDR notation for the source/destination network address range
restorations.ports.security_groups.rules.description string
restorations.ports.security_groups.rules.remote_group_name string
restorations.ports.security_groups.rules.remote_group_uuid string (uuid)
restorations.ports.security_groups.rules.id integer
restorations.ports.security_groups.rules.remote_group string (uri) Remote security group that this rule references, if any
restorations.ports.security_groups.marketplace_offering_uuid string
restorations.ports.security_groups.marketplace_offering_name string
restorations.ports.security_groups.marketplace_offering_plugin_options object (free-form)
restorations.ports.security_groups.marketplace_category_uuid string
restorations.ports.security_groups.marketplace_category_name string
restorations.ports.security_groups.marketplace_resource_uuid string
restorations.ports.security_groups.marketplace_plan_uuid string
restorations.ports.security_groups.marketplace_resource_state string
restorations.ports.security_groups.is_usage_based boolean
restorations.ports.security_groups.is_limit_based boolean
instance_security_groups array of objects
instance_security_groups.url string (uri)
instance_security_groups.name string
instance_security_groups.rules array of objects
instance_security_groups.rules.ethertype any IP protocol version - either 'IPv4' or 'IPv6'
instance_security_groups.rules.direction any Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing)
instance_security_groups.rules.protocol any The network protocol (TCP, UDP, ICMP, or empty for any protocol)
instance_security_groups.rules.from_port integer Starting port number in the range (1-65535)
instance_security_groups.rules.to_port integer Ending port number in the range (1-65535)
instance_security_groups.rules.cidr string CIDR notation for the source/destination network address range
instance_security_groups.rules.description string
instance_security_groups.rules.remote_group_name string
instance_security_groups.rules.remote_group_uuid string (uuid)
instance_security_groups.rules.id integer
instance_security_groups.description string
instance_security_groups.state string
instance_ports array of objects
instance_ports.url string (uri)
instance_ports.fixed_ips array of objects
instance_ports.fixed_ips.ip_address any IP address to assign to the port
instance_ports.fixed_ips.subnet_id string ID of the subnet in which to assign the IP address
instance_ports.mac_address string MAC address of the port
instance_ports.subnet string (uri) Subnet to which this port belongs
instance_ports.subnet_uuid string (uuid)
instance_ports.subnet_name string
instance_ports.subnet_description string
instance_ports.subnet_cidr string IPv4 network address in CIDR format (e.g. 192.168.0.0/24)
instance_ports.allowed_address_pairs array of objects
instance_ports.allowed_address_pairs.mac_address string
instance_ports.device_id string ID of device (instance, router etc) to which this port is connected
instance_ports.device_owner string Entity that uses this port (e.g. network:router_interface)
instance_ports.security_groups array of objects
instance_ports.security_groups.url string (uri)
instance_ports.security_groups.uuid string (uuid)
instance_ports.security_groups.name string
instance_ports.security_groups.description string
instance_ports.security_groups.service_name string
instance_ports.security_groups.service_settings string (uri)
instance_ports.security_groups.service_settings_uuid string (uuid)
instance_ports.security_groups.service_settings_state string
instance_ports.security_groups.service_settings_error_message string
instance_ports.security_groups.project string (uri)
instance_ports.security_groups.project_name string
instance_ports.security_groups.project_uuid string (uuid)
instance_ports.security_groups.customer string (uri)
instance_ports.security_groups.customer_uuid string (uuid)
instance_ports.security_groups.customer_name string
instance_ports.security_groups.customer_native_name string
instance_ports.security_groups.customer_abbreviation string
instance_ports.security_groups.error_message string
instance_ports.security_groups.error_traceback string
instance_ports.security_groups.resource_type string
instance_ports.security_groups.state any
instance_ports.security_groups.created string (date-time)
instance_ports.security_groups.modified string (date-time)
instance_ports.security_groups.backend_id string
instance_ports.security_groups.access_url string
instance_ports.security_groups.tenant string (uri)
instance_ports.security_groups.tenant_name string
instance_ports.security_groups.tenant_uuid string (uuid)
instance_ports.security_groups.rules array of objects
instance_ports.security_groups.rules.ethertype any IP protocol version - either 'IPv4' or 'IPv6'
instance_ports.security_groups.rules.direction any Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing)
instance_ports.security_groups.rules.protocol any The network protocol (TCP, UDP, ICMP, or empty for any protocol)
instance_ports.security_groups.rules.from_port integer Starting port number in the range (1-65535)
instance_ports.security_groups.rules.to_port integer Ending port number in the range (1-65535)
instance_ports.security_groups.rules.cidr string CIDR notation for the source/destination network address range
instance_ports.security_groups.rules.description string
instance_ports.security_groups.rules.remote_group_name string
instance_ports.security_groups.rules.remote_group_uuid string (uuid)
instance_ports.security_groups.rules.id integer
instance_ports.security_groups.rules.remote_group string (uri) Remote security group that this rule references, if any
instance_ports.security_groups.marketplace_offering_uuid string
instance_ports.security_groups.marketplace_offering_name string
instance_ports.security_groups.marketplace_offering_plugin_options object (free-form)
instance_ports.security_groups.marketplace_category_uuid string
instance_ports.security_groups.marketplace_category_name string
instance_ports.security_groups.marketplace_resource_uuid string
instance_ports.security_groups.marketplace_plan_uuid string
instance_ports.security_groups.marketplace_resource_state string
instance_ports.security_groups.is_usage_based boolean
instance_ports.security_groups.is_limit_based boolean
instance_floating_ips array of objects
instance_floating_ips.url string (uri)
instance_floating_ips.uuid string (uuid)
instance_floating_ips.address any The public IPv4 address of the floating IP
instance_floating_ips.port_fixed_ips array of objects
instance_floating_ips.port_fixed_ips.ip_address any IP address to assign to the port
instance_floating_ips.port_fixed_ips.subnet_id string ID of the subnet in which to assign the IP address
instance_floating_ips.port_mac_address string MAC address of the port
instance_floating_ips.subnet string (uri)
instance_floating_ips.subnet_uuid string (uuid)
instance_floating_ips.subnet_name string
instance_floating_ips.subnet_description string
instance_floating_ips.subnet_cidr string IPv4 network address in CIDR format (e.g. 192.168.0.0/24)
tenant_uuid string (uuid)
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Update instance allowed address pairs

Update allowed address pairs of the instance

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/openstack-instances/a1b2c3d4-e5f6-7890-abcd-ef1234567890/update_allowed_address_pairs/ \
  Authorization:"Token YOUR_API_TOKEN" \
  subnet="https://api.example.com/api/subnet/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  allowed_address_pairs:='[]'

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.open_stack_instance_allowed_address_pairs_update_request import OpenStackInstanceAllowedAddressPairsUpdateRequest # (1)
from waldur_api_client.api.openstack_instances import openstack_instances_update_allowed_address_pairs # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OpenStackInstanceAllowedAddressPairsUpdateRequest(
    subnet="https://api.example.com/api/subnet/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    allowed_address_pairs=[]
)
response = openstack_instances_update_allowed_address_pairs.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OpenStackInstanceAllowedAddressPairsUpdateRequest
  2. API Source: openstack_instances_update_allowed_address_pairs
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { openstackInstancesUpdateAllowedAddressPairs } from 'waldur-js-client';

try {
  const response = await openstackInstancesUpdateAllowedAddressPairs({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "subnet": "https://api.example.com/api/subnet/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "allowed_address_pairs": []
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
subnet string (uri) ✓ The subnet to update allowed address pairs for.
Constraints: write-only
allowed_address_pairs array of objects ✓ List of allowed address pairs to set on the port. Each pair should contain 'ip_address' and optional 'mac_address'.
allowed_address_pairs.ip_address string
Constraints: write-only, default: 192.168.42.0/24
allowed_address_pairs.mac_address string

200 - No response body

Update instance floating IPs

Update floating IPs of the instance

1
2
3
4
http \
  POST \
  https://api.example.com/api/openstack-instances/a1b2c3d4-e5f6-7890-abcd-ef1234567890/update_floating_ips/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.open_stack_instance_floating_i_ps_update_request import OpenStackInstanceFloatingIPsUpdateRequest # (1)
from waldur_api_client.api.openstack_instances import openstack_instances_update_floating_ips # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OpenStackInstanceFloatingIPsUpdateRequest()
response = openstack_instances_update_floating_ips.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OpenStackInstanceFloatingIPsUpdateRequest
  2. API Source: openstack_instances_update_floating_ips
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackInstancesUpdateFloatingIps } from 'waldur-js-client';

try {
  const response = await openstackInstancesUpdateFloatingIps({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
floating_ips array of objects
floating_ips.url string (uri)
floating_ips.ip_address any Existing floating IP address in selected OpenStack tenant to be assigned to new virtual machine
floating_ips.subnet string (uri) ✓

200 - No response body

Update instance ports

Update ports of the instance

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/openstack-instances/a1b2c3d4-e5f6-7890-abcd-ef1234567890/update_ports/ \
  Authorization:"Token YOUR_API_TOKEN" \
  ports:='["private-vlan-port"]'

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.open_stack_instance_ports_update_request import OpenStackInstancePortsUpdateRequest # (1)
from waldur_api_client.api.openstack_instances import openstack_instances_update_ports # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OpenStackInstancePortsUpdateRequest(
    ports=[
            "private-vlan-port"
        ]
)
response = openstack_instances_update_ports.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OpenStackInstancePortsUpdateRequest
  2. API Source: openstack_instances_update_ports
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
import { openstackInstancesUpdatePorts } from 'waldur-js-client';

try {
  const response = await openstackInstancesUpdatePorts({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "ports": [
      "private-vlan-port"
    ]
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
ports array of objects ✓
ports.fixed_ips array of objects
ports.fixed_ips.ip_address any ✓ IP address to assign to the port
ports.fixed_ips.subnet_id string ✓ ID of the subnet in which to assign the IP address
ports.subnet string (uri) Subnet to which this port belongs
ports.port string (uri)
ports.tenant string (uri) Target tenant for port creation. If not specified, uses subnet's tenant.
Constraints: write-only

200 - No response body

Update instance security groups

Update security groups of the instance

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/openstack-instances/a1b2c3d4-e5f6-7890-abcd-ef1234567890/update_security_groups/ \
  Authorization:"Token YOUR_API_TOKEN" \
  security_groups:='["web-server-sg"]'

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.open_stack_instance_security_groups_update_request import OpenStackInstanceSecurityGroupsUpdateRequest # (1)
from waldur_api_client.api.openstack_instances import openstack_instances_update_security_groups # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OpenStackInstanceSecurityGroupsUpdateRequest(
    security_groups=[
            "web-server-sg"
        ]
)
response = openstack_instances_update_security_groups.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OpenStackInstanceSecurityGroupsUpdateRequest
  2. API Source: openstack_instances_update_security_groups
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
import { openstackInstancesUpdateSecurityGroups } from 'waldur-js-client';

try {
  const response = await openstackInstancesUpdateSecurityGroups({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "security_groups": [
      "web-server-sg"
    ]
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
security_groups array of string (uri)s ✓ List of security groups to be assigned to the instance.

200 - No response body

Other Actions

Change instance flavor

Change flavor of the instance

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/openstack-instances/a1b2c3d4-e5f6-7890-abcd-ef1234567890/change_flavor/ \
  Authorization:"Token YOUR_API_TOKEN" \
  flavor="https://api.example.com/api/flavor/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.instance_flavor_change_request import InstanceFlavorChangeRequest # (1)
from waldur_api_client.api.openstack_instances import openstack_instances_change_flavor # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = InstanceFlavorChangeRequest(
    flavor="https://api.example.com/api/flavor/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = openstack_instances_change_flavor.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: InstanceFlavorChangeRequest
  2. API Source: openstack_instances_change_flavor
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { openstackInstancesChangeFlavor } from 'waldur-js-client';

try {
  const response = await openstackInstancesChangeFlavor({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "flavor": "https://api.example.com/api/flavor/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
flavor string (uri) ✓ The new flavor to use for the instance. Flavor change can only be done when instance is stopped.

200 - No response body

Mark resource as ERRED

Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.

1
2
3
4
http \
  POST \
  https://api.example.com/api/openstack-instances/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_erred/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.set_erred_request import SetErredRequest # (1)
from waldur_api_client.api.openstack_instances import openstack_instances_set_erred # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = SetErredRequest()
response = openstack_instances_set_erred.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: SetErredRequest
  2. API Source: openstack_instances_set_erred
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackInstancesSetErred } from 'waldur-js-client';

try {
  const response = await openstackInstancesSetErred({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
error_message string
error_traceback string

200 -

Field Type
detail string

Mark resource as OK

Manually transition the resource to OK state and clear error fields. Staff-only operation.

1
2
3
4
http \
  POST \
  https://api.example.com/api/openstack-instances/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_ok/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_instances import openstack_instances_set_ok # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_instances_set_ok.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openstack_instances_set_ok
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackInstancesSetOk } from 'waldur-js-client';

try {
  const response = await openstackInstancesSetOk({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
detail string

Openstack Marketplace Tenants

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/openstack-marketplace-tenants/ List Openstack Marketplace Tenants
GET /api/openstack-marketplace-tenants/{uuid}/ Retrieve
POST /api/openstack-marketplace-tenants/{uuid}/create_image/ Create image
Other Actions
POST /api/openstack-marketplace-tenants/{uuid}/upload_image_data/{image_id}/ Data

Core CRUD

List Openstack Marketplace Tenants

1
2
3
4
http \
  GET \
  https://api.example.com/api/openstack-marketplace-tenants/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.core_states import CoreStates # (1)
from waldur_api_client.api.openstack_marketplace_tenants import openstack_marketplace_tenants_list # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_marketplace_tenants_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: CoreStates
  2. API Source: openstack_marketplace_tenants_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { openstackMarketplaceTenantsList } from 'waldur-js-client';

try {
  const response = await openstackMarketplaceTenantsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
backend_id string Backend ID
can_manage boolean Can manage
customer string (uuid) Customer UUID
customer_abbreviation string Customer abbreviation
customer_name string Customer name
customer_native_name string Customer native name
customer_uuid string (uuid) Customer UUID
description string Description
external_ip string External IP
name string Name
name_exact string Name (exact)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
project string (uuid) Project UUID
project_name string Project name
project_uuid string (uuid) Project UUID
service_settings_name string Service settings name
service_settings_uuid string (uuid) Service settings UUID
state array State
uuid string (uuid) UUID

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
url string (uri)
uuid string (uuid)
name string

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/openstack-marketplace-tenants/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_marketplace_tenants import openstack_marketplace_tenants_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_marketplace_tenants_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openstack_marketplace_tenants_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackMarketplaceTenantsRetrieve } from 'waldur-js-client';

try {
  const response = await openstackMarketplaceTenantsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
url string (uri)
uuid string (uuid)
name string

Create image

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/openstack-marketplace-tenants/a1b2c3d4-e5f6-7890-abcd-ef1234567890/create_image/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-openstack-marketplace-tenant"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.image_create_request import ImageCreateRequest # (1)
from waldur_api_client.api.openstack_marketplace_tenants import openstack_marketplace_tenants_create_image # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ImageCreateRequest(
    name="my-awesome-openstack-marketplace-tenant"
)
response = openstack_marketplace_tenants_create_image.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ImageCreateRequest
  2. API Source: openstack_marketplace_tenants_create_image
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { openstackMarketplaceTenantsCreateImage } from 'waldur-js-client';

try {
  const response = await openstackMarketplaceTenantsCreateImage({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-openstack-marketplace-tenant"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
name string ✓
min_ram integer
min_disk integer
disk_format any
container_format any
visibility any

201 -

Field Type
image_id string (uuid)
name string
status string
upload_url string

Other Actions

Data

1
2
3
4
http \
  POST \
  https://api.example.com/api/openstack-marketplace-tenants/a1b2c3d4-e5f6-7890-abcd-ef1234567890/upload_image_data/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_marketplace_tenants import openstack_marketplace_tenants_upload_image_data # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_marketplace_tenants_upload_image_data.sync(
    image_id="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openstack_marketplace_tenants_upload_image_data
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { openstackMarketplaceTenantsUploadImageData } from 'waldur-js-client';

try {
  const response = await openstackMarketplaceTenantsUploadImageData({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "image_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
image_id string (uuid) ✓
uuid string (uuid) ✓

200 -

Field Type
status string
message string

Openstack Migrations

Operations Summary

Method Endpoint Description
GET /api/openstack-migrations/ List Openstack Migrations
GET /api/openstack-migrations/{uuid}/ Retrieve
POST /api/openstack-migrations/ Create
PUT /api/openstack-migrations/{uuid}/ Update
PATCH /api/openstack-migrations/{uuid}/ Partial Update
DELETE /api/openstack-migrations/{uuid}/ Delete

List Openstack Migrations

1
2
3
4
http \
  GET \
  https://api.example.com/api/openstack-migrations/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_migrations import openstack_migrations_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_migrations_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: openstack_migrations_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { openstackMigrationsList } from 'waldur-js-client';

try {
  const response = await openstackMigrationsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
dst_resource_uuid string (uuid)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
src_resource_uuid string (uuid)

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
uuid string (uuid)
created string (date-time)
modified string (date-time)
mappings object
mappings.volume_types array of objects
mappings.volume_types.src_type_uuid string (uuid)
mappings.volume_types.dst_type_uuid string (uuid)
mappings.subnets array of objects
mappings.subnets.src_cidr string
mappings.subnets.dst_cidr string
mappings.skip_connection_extnet boolean
mappings.sync_instance_ports boolean
mappings.networks array of string (uuid)s
created_by_uuid string (uuid)
created_by_full_name string
src_offering_uuid string (uuid)
src_offering_name string
dst_offering_uuid string (uuid)
dst_offering_name string
src_resource_uuid string (uuid)
src_resource_name string
dst_resource_uuid string (uuid)
dst_resource_name string
dst_resource_state string
state string
error_message string
error_traceback string

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/openstack-migrations/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_migrations import openstack_migrations_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_migrations_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openstack_migrations_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackMigrationsRetrieve } from 'waldur-js-client';

try {
  const response = await openstackMigrationsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
uuid string (uuid)
created string (date-time)
modified string (date-time)
mappings object
mappings.volume_types array of objects
mappings.volume_types.src_type_uuid string (uuid)
mappings.volume_types.dst_type_uuid string (uuid)
mappings.subnets array of objects
mappings.subnets.src_cidr string
mappings.subnets.dst_cidr string
mappings.skip_connection_extnet boolean
mappings.sync_instance_ports boolean
mappings.networks array of string (uuid)s
created_by_uuid string (uuid)
created_by_full_name string
src_offering_uuid string (uuid)
src_offering_name string
dst_offering_uuid string (uuid)
dst_offering_name string
src_resource_uuid string (uuid)
src_resource_name string
dst_resource_uuid string (uuid)
dst_resource_name string
dst_resource_state string
state string
error_message string
error_traceback string

Create

1
2
3
4
5
6
7
http \
  POST \
  https://api.example.com/api/openstack-migrations/ \
  Authorization:"Token YOUR_API_TOKEN" \
  src_resource="a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  dst_offering="a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  dst_plan="a1b2c3d4-e5f6-7890-abcd-ef1234567890"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.migration_create_request import MigrationCreateRequest # (1)
from waldur_api_client.api.openstack_migrations import openstack_migrations_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = MigrationCreateRequest(
    src_resource="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    dst_offering="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    dst_plan="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
)
response = openstack_migrations_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: MigrationCreateRequest
  2. API Source: openstack_migrations_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
import { openstackMigrationsCreate } from 'waldur-js-client';

try {
  const response = await openstackMigrationsCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "src_resource": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "dst_offering": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "dst_plan": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required
name string
description string
mappings object
mappings.volume_types array of objects
mappings.volume_types.src_type_uuid string (uuid) ✓
mappings.volume_types.dst_type_uuid string (uuid) ✓
mappings.subnets array of objects
mappings.subnets.src_cidr string ✓
mappings.subnets.dst_cidr string ✓
mappings.skip_connection_extnet boolean
mappings.sync_instance_ports boolean
mappings.networks array of string (uuid)s
src_resource string (uuid) ✓
dst_offering string (uuid) ✓
dst_plan string (uuid) ✓

201 -

Field Type
mappings object
mappings.volume_types array of objects
mappings.volume_types.src_type_uuid string (uuid)
mappings.volume_types.dst_type_uuid string (uuid)
mappings.subnets array of objects
mappings.subnets.src_cidr string
mappings.subnets.dst_cidr string
mappings.skip_connection_extnet boolean
mappings.sync_instance_ports boolean
mappings.networks array of string (uuid)s
src_resource string (uuid)

Update

1
2
3
4
5
http \
  PUT \
  https://api.example.com/api/openstack-migrations/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  mappings:='{}'

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.migration_details_request import MigrationDetailsRequest # (1)
from waldur_api_client.api.openstack_migrations import openstack_migrations_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = MigrationDetailsRequest(
    mappings={}
)
response = openstack_migrations_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: MigrationDetailsRequest
  2. API Source: openstack_migrations_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { openstackMigrationsUpdate } from 'waldur-js-client';

try {
  const response = await openstackMigrationsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "mappings": {}
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
mappings object ✓
mappings.volume_types array of objects
mappings.volume_types.src_type_uuid string (uuid) ✓
mappings.volume_types.dst_type_uuid string (uuid) ✓
mappings.subnets array of objects
mappings.subnets.src_cidr string ✓
mappings.subnets.dst_cidr string ✓
mappings.skip_connection_extnet boolean
mappings.sync_instance_ports boolean
mappings.networks array of string (uuid)s
error_message string
error_traceback string

200 -

Field Type
uuid string (uuid)
created string (date-time)
modified string (date-time)
mappings object
mappings.volume_types array of objects
mappings.volume_types.src_type_uuid string (uuid)
mappings.volume_types.dst_type_uuid string (uuid)
mappings.subnets array of objects
mappings.subnets.src_cidr string
mappings.subnets.dst_cidr string
mappings.skip_connection_extnet boolean
mappings.sync_instance_ports boolean
mappings.networks array of string (uuid)s
created_by_uuid string (uuid)
created_by_full_name string
src_offering_uuid string (uuid)
src_offering_name string
dst_offering_uuid string (uuid)
dst_offering_name string
src_resource_uuid string (uuid)
src_resource_name string
dst_resource_uuid string (uuid)
dst_resource_name string
dst_resource_state string
state string
error_message string
error_traceback string

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/openstack-migrations/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_migration_details_request import PatchedMigrationDetailsRequest # (1)
from waldur_api_client.api.openstack_migrations import openstack_migrations_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedMigrationDetailsRequest()
response = openstack_migrations_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedMigrationDetailsRequest
  2. API Source: openstack_migrations_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackMigrationsPartialUpdate } from 'waldur-js-client';

try {
  const response = await openstackMigrationsPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
mappings object
mappings.volume_types array of objects
mappings.volume_types.src_type_uuid string (uuid) ✓
mappings.volume_types.dst_type_uuid string (uuid) ✓
mappings.subnets array of objects
mappings.subnets.src_cidr string ✓
mappings.subnets.dst_cidr string ✓
mappings.skip_connection_extnet boolean
mappings.sync_instance_ports boolean
mappings.networks array of string (uuid)s
error_message string
error_traceback string

200 -

Field Type
uuid string (uuid)
created string (date-time)
modified string (date-time)
mappings object
mappings.volume_types array of objects
mappings.volume_types.src_type_uuid string (uuid)
mappings.volume_types.dst_type_uuid string (uuid)
mappings.subnets array of objects
mappings.subnets.src_cidr string
mappings.subnets.dst_cidr string
mappings.skip_connection_extnet boolean
mappings.sync_instance_ports boolean
mappings.networks array of string (uuid)s
created_by_uuid string (uuid)
created_by_full_name string
src_offering_uuid string (uuid)
src_offering_name string
dst_offering_uuid string (uuid)
dst_offering_name string
src_resource_uuid string (uuid)
src_resource_name string
dst_resource_uuid string (uuid)
dst_resource_name string
dst_resource_state string
state string
error_message string
error_traceback string

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/openstack-migrations/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_migrations import openstack_migrations_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_migrations_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openstack_migrations_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackMigrationsDestroy } from 'waldur-js-client';

try {
  const response = await openstackMigrationsDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Openstack Network Rbac Policies

Operations Summary

Method Endpoint Description
GET /api/openstack-network-rbac-policies/ List network RBAC policies
GET /api/openstack-network-rbac-policies/{uuid}/ Get network RBAC policy details
POST /api/openstack-network-rbac-policies/ Create RBAC policy
PUT /api/openstack-network-rbac-policies/{uuid}/ Update
PATCH /api/openstack-network-rbac-policies/{uuid}/ Partial Update
DELETE /api/openstack-network-rbac-policies/{uuid}/ Delete RBAC policy

List network RBAC policies

Get a list of network RBAC policies.

1
2
3
4
http \
  GET \
  https://api.example.com/api/openstack-network-rbac-policies/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.policy_type_enum import PolicyTypeEnum # (1)
from waldur_api_client.api.openstack_network_rbac_policies import openstack_network_rbac_policies_list # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_network_rbac_policies_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: PolicyTypeEnum
  2. API Source: openstack_network_rbac_policies_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { openstackNetworkRbacPoliciesList } from 'waldur-js-client';

try {
  const response = await openstackNetworkRbacPoliciesList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
network string (uri) Network URL
network_uuid string (uuid) Network UUID
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
policy_type string Type of access granted - either shared access or external network access


Enum: access_as_shared, access_as_external
target_tenant string (uri) Target tenant URL
target_tenant_uuid string (uuid) Target tenant UUID
tenant string (uri) Tenant URL
tenant_uuid string (uuid) Tenant UUID

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
network string (uri)
network_name string
target_tenant string (uri)
target_tenant_name string
backend_id string
policy_type any Type of access granted - either shared access or external network access
created string (date-time)

Get network RBAC policy details

Retrieve details of a specific network RBAC policy.

1
2
3
4
http \
  GET \
  https://api.example.com/api/openstack-network-rbac-policies/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_network_rbac_policies import openstack_network_rbac_policies_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_network_rbac_policies_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openstack_network_rbac_policies_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackNetworkRbacPoliciesRetrieve } from 'waldur-js-client';

try {
  const response = await openstackNetworkRbacPoliciesRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
url string (uri)
uuid string (uuid)
network string (uri)
network_name string
target_tenant string (uri)
target_tenant_name string
backend_id string
policy_type any Type of access granted - either shared access or external network access
created string (date-time)

Create RBAC policy

Create RBAC policy for the network

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/openstack-network-rbac-policies/ \
  Authorization:"Token YOUR_API_TOKEN" \
  network="https://api.example.com/api/network/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  target_tenant="https://api.example.com/api/target-tenant/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.network_rbac_policy_request import NetworkRBACPolicyRequest # (1)
from waldur_api_client.api.openstack_network_rbac_policies import openstack_network_rbac_policies_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = NetworkRBACPolicyRequest(
    network="https://api.example.com/api/network/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    target_tenant="https://api.example.com/api/target-tenant/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = openstack_network_rbac_policies_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: NetworkRBACPolicyRequest
  2. API Source: openstack_network_rbac_policies_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { openstackNetworkRbacPoliciesCreate } from 'waldur-js-client';

try {
  const response = await openstackNetworkRbacPoliciesCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "network": "https://api.example.com/api/network/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "target_tenant": "https://api.example.com/api/target-tenant/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
network string (uri) ✓
target_tenant string (uri) ✓
policy_type any Type of access granted - either shared access or external network access
Constraints: default: access_as_shared

201 -

Field Type Description
url string (uri)
uuid string (uuid)
network string (uri)
network_name string
target_tenant string (uri)
target_tenant_name string
backend_id string
policy_type any Type of access granted - either shared access or external network access
created string (date-time)

Update

1
2
3
4
5
6
http \
  PUT \
  https://api.example.com/api/openstack-network-rbac-policies/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  network="https://api.example.com/api/network/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  target_tenant="https://api.example.com/api/target-tenant/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.network_rbac_policy_request import NetworkRBACPolicyRequest # (1)
from waldur_api_client.api.openstack_network_rbac_policies import openstack_network_rbac_policies_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = NetworkRBACPolicyRequest(
    network="https://api.example.com/api/network/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    target_tenant="https://api.example.com/api/target-tenant/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = openstack_network_rbac_policies_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: NetworkRBACPolicyRequest
  2. API Source: openstack_network_rbac_policies_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { openstackNetworkRbacPoliciesUpdate } from 'waldur-js-client';

try {
  const response = await openstackNetworkRbacPoliciesUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "network": "https://api.example.com/api/network/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "target_tenant": "https://api.example.com/api/target-tenant/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
network string (uri) ✓
target_tenant string (uri) ✓
policy_type any Type of access granted - either shared access or external network access
Constraints: default: access_as_shared

200 -

Field Type Description
url string (uri)
uuid string (uuid)
network string (uri)
network_name string
target_tenant string (uri)
target_tenant_name string
backend_id string
policy_type any Type of access granted - either shared access or external network access
created string (date-time)

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/openstack-network-rbac-policies/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_network_rbac_policy_request import PatchedNetworkRBACPolicyRequest # (1)
from waldur_api_client.api.openstack_network_rbac_policies import openstack_network_rbac_policies_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedNetworkRBACPolicyRequest()
response = openstack_network_rbac_policies_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedNetworkRBACPolicyRequest
  2. API Source: openstack_network_rbac_policies_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackNetworkRbacPoliciesPartialUpdate } from 'waldur-js-client';

try {
  const response = await openstackNetworkRbacPoliciesPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
network string (uri)
target_tenant string (uri)
policy_type any Type of access granted - either shared access or external network access
Constraints: default: access_as_shared

200 -

Field Type Description
url string (uri)
uuid string (uuid)
network string (uri)
network_name string
target_tenant string (uri)
target_tenant_name string
backend_id string
policy_type any Type of access granted - either shared access or external network access
created string (date-time)

Delete RBAC policy

Delete RBAC policy for the network

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/openstack-network-rbac-policies/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_network_rbac_policies import openstack_network_rbac_policies_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_network_rbac_policies_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openstack_network_rbac_policies_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackNetworkRbacPoliciesDestroy } from 'waldur-js-client';

try {
  const response = await openstackNetworkRbacPoliciesDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Openstack Networks

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/openstack-networks/ List networks
GET /api/openstack-networks/{uuid}/ Get network details
POST /api/openstack-networks/{uuid}/create_subnet/ Create subnet
POST /api/openstack-networks/{uuid}/pull/ Synchronize resource state
POST /api/openstack-networks/{uuid}/unlink/ Unlink resource
PUT /api/openstack-networks/{uuid}/ Update network
PATCH /api/openstack-networks/{uuid}/ Partially update network
DELETE /api/openstack-networks/{uuid}/ Delete network
Other Actions
POST /api/openstack-networks/{uuid}/rbac_policy_create/ Create RBAC policy
POST /api/openstack-networks/{uuid}/set_erred/ Mark resource as ERRED
POST /api/openstack-networks/{uuid}/set_mtu/ Set network MTU
POST /api/openstack-networks/{uuid}/set_ok/ Mark resource as OK
DELETE /api/openstack-networks/{uuid}/rbac_policy_delete/{rbac_policy_uuid}/ Delete RBAC policy

Core CRUD

List networks

Get a list of networks.

1
2
3
4
http \
  GET \
  https://api.example.com/api/openstack-networks/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.core_states import CoreStates # (1)
from waldur_api_client.models.open_stack_network_field_enum import OpenStackNetworkFieldEnum # (2)
from waldur_api_client.api.openstack_networks import openstack_networks_list # (3)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_networks_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: CoreStates
  2. Model Source: OpenStackNetworkFieldEnum
  3. API Source: openstack_networks_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { openstackNetworksList } from 'waldur-js-client';

try {
  const response = await openstackNetworksList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
backend_id string Backend ID
can_manage boolean Can manage
customer string (uuid) Customer UUID
customer_abbreviation string Customer abbreviation
customer_name string Customer name
customer_native_name string Customer native name
customer_uuid string (uuid) Customer UUID
description string Description
direct_only boolean Direct only
external_ip string External IP
field array
is_external boolean
name string Name
name_exact string Name (exact)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
project string (uuid) Project UUID
project_name string Project name
project_uuid string (uuid) Project UUID
rbac_only boolean RBAC only
service_settings_name string Service settings name
service_settings_uuid string (uuid) Service settings UUID
state array State
tenant string (uri) Tenant URL
tenant_uuid string (uuid) Tenant UUID
type string
uuid string (uuid) UUID

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
tenant string (uri) OpenStack tenant this network belongs to
tenant_name string
tenant_uuid string (uuid)
is_external boolean Defines whether this network is external (public) or internal (private)
type string Network type, such as local, flat, vlan, vxlan, or gre
segmentation_id integer VLAN ID for VLAN networks or tunnel ID for VXLAN/GRE networks
subnets array of objects
subnets.uuid string (uuid)
subnets.name string
subnets.description string
subnets.cidr string IPv4 network address in CIDR format (e.g. 192.168.0.0/24)
subnets.gateway_ip any IP address of the gateway for this subnet
subnets.allocation_pools array of objects
subnets.allocation_pools.start any An IPv4 or IPv6 address.
subnets.allocation_pools.end any An IPv4 or IPv6 address.
subnets.ip_version integer IP protocol version (4 or 6)
subnets.enable_dhcp boolean If True, DHCP service will be enabled on this subnet
mtu integer The maximum transmission unit (MTU) value to address fragmentation.
rbac_policies array of objects
rbac_policies.url string (uri)
rbac_policies.uuid string (uuid)
rbac_policies.network string (uri)
rbac_policies.network_name string
rbac_policies.target_tenant string (uri)
rbac_policies.target_tenant_name string
rbac_policies.backend_id string
rbac_policies.policy_type any Type of access granted - either shared access or external network access
rbac_policies.created string (date-time)
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Get network details

Retrieve details of a specific network.

1
2
3
4
http \
  GET \
  https://api.example.com/api/openstack-networks/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.open_stack_network_field_enum import OpenStackNetworkFieldEnum # (1)
from waldur_api_client.api.openstack_networks import openstack_networks_retrieve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_networks_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. Model Source: OpenStackNetworkFieldEnum
  2. API Source: openstack_networks_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackNetworksRetrieve } from 'waldur-js-client';

try {
  const response = await openstackNetworksRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type
field array

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
tenant string (uri) OpenStack tenant this network belongs to
tenant_name string
tenant_uuid string (uuid)
is_external boolean Defines whether this network is external (public) or internal (private)
type string Network type, such as local, flat, vlan, vxlan, or gre
segmentation_id integer VLAN ID for VLAN networks or tunnel ID for VXLAN/GRE networks
subnets array of objects
subnets.uuid string (uuid)
subnets.name string
subnets.description string
subnets.cidr string IPv4 network address in CIDR format (e.g. 192.168.0.0/24)
subnets.gateway_ip any IP address of the gateway for this subnet
subnets.allocation_pools array of objects
subnets.allocation_pools.start any An IPv4 or IPv6 address.
subnets.allocation_pools.end any An IPv4 or IPv6 address.
subnets.ip_version integer IP protocol version (4 or 6)
subnets.enable_dhcp boolean If True, DHCP service will be enabled on this subnet
mtu integer The maximum transmission unit (MTU) value to address fragmentation.
rbac_policies array of objects
rbac_policies.url string (uri)
rbac_policies.uuid string (uuid)
rbac_policies.network string (uri)
rbac_policies.network_name string
rbac_policies.target_tenant string (uri)
rbac_policies.target_tenant_name string
rbac_policies.backend_id string
rbac_policies.policy_type any Type of access granted - either shared access or external network access
rbac_policies.created string (date-time)
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Create subnet

Create a new subnet within the network.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/openstack-networks/a1b2c3d4-e5f6-7890-abcd-ef1234567890/create_subnet/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-openstack-network"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.open_stack_sub_net_request import OpenStackSubNetRequest # (1)
from waldur_api_client.api.openstack_networks import openstack_networks_create_subnet # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OpenStackSubNetRequest(
    name="my-awesome-openstack-network"
)
response = openstack_networks_create_subnet.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OpenStackSubNetRequest
  2. API Source: openstack_networks_create_subnet
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { openstackNetworksCreateSubnet } from 'waldur-js-client';

try {
  const response = await openstackNetworksCreateSubnet({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-openstack-network"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
name string ✓
description string
cidr string
gateway_ip any IP address of the gateway for this subnet
disable_gateway boolean If True, no gateway IP address will be allocated
allocation_pools array of objects
allocation_pools.start any ✓ An IPv4 or IPv6 address.
allocation_pools.end any ✓ An IPv4 or IPv6 address.
dns_nameservers array of anys
host_routes array of objects
host_routes.destination string ✓
host_routes.nexthop any ✓ An IPv4 or IPv6 address.

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
tenant string (uri)
tenant_name string
network string (uri) Network to which this subnet belongs
network_name string
cidr string
gateway_ip any IP address of the gateway for this subnet
disable_gateway boolean If True, no gateway IP address will be allocated
allocation_pools array of objects
allocation_pools.start any An IPv4 or IPv6 address.
allocation_pools.end any An IPv4 or IPv6 address.
ip_version integer IP protocol version (4 or 6)
enable_dhcp boolean If True, DHCP service will be enabled on this subnet
dns_nameservers array of anys
host_routes array of objects
host_routes.destination string
host_routes.nexthop any An IPv4 or IPv6 address.
is_connected boolean Is subnet connected to the default tenant router.
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Synchronize resource state

Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.

1
2
3
4
http \
  POST \
  https://api.example.com/api/openstack-networks/a1b2c3d4-e5f6-7890-abcd-ef1234567890/pull/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_networks import openstack_networks_pull # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_networks_pull.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openstack_networks_pull
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackNetworksPull } from 'waldur-js-client';

try {
  const response = await openstackNetworksPull({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

202 -

Field Type
detail string

409 -

Field Type
detail string

Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state.

1
2
3
4
http \
  POST \
  https://api.example.com/api/openstack-networks/a1b2c3d4-e5f6-7890-abcd-ef1234567890/unlink/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_networks import openstack_networks_unlink # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_networks_unlink.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openstack_networks_unlink
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackNetworksUnlink } from 'waldur-js-client';

try {
  const response = await openstackNetworksUnlink({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Update network

Update an existing network.

1
2
3
4
5
http \
  PUT \
  https://api.example.com/api/openstack-networks/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-openstack-network"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.open_stack_network_request import OpenStackNetworkRequest # (1)
from waldur_api_client.api.openstack_networks import openstack_networks_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OpenStackNetworkRequest(
    name="my-awesome-openstack-network"
)
response = openstack_networks_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OpenStackNetworkRequest
  2. API Source: openstack_networks_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { openstackNetworksUpdate } from 'waldur-js-client';

try {
  const response = await openstackNetworksUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-openstack-network"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
name string ✓
description string

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
tenant string (uri) OpenStack tenant this network belongs to
tenant_name string
tenant_uuid string (uuid)
is_external boolean Defines whether this network is external (public) or internal (private)
type string Network type, such as local, flat, vlan, vxlan, or gre
segmentation_id integer VLAN ID for VLAN networks or tunnel ID for VXLAN/GRE networks
subnets array of objects
subnets.uuid string (uuid)
subnets.name string
subnets.description string
subnets.cidr string IPv4 network address in CIDR format (e.g. 192.168.0.0/24)
subnets.gateway_ip any IP address of the gateway for this subnet
subnets.allocation_pools array of objects
subnets.allocation_pools.start any An IPv4 or IPv6 address.
subnets.allocation_pools.end any An IPv4 or IPv6 address.
subnets.ip_version integer IP protocol version (4 or 6)
subnets.enable_dhcp boolean If True, DHCP service will be enabled on this subnet
mtu integer The maximum transmission unit (MTU) value to address fragmentation.
rbac_policies array of objects
rbac_policies.url string (uri)
rbac_policies.uuid string (uuid)
rbac_policies.network string (uri)
rbac_policies.network_name string
rbac_policies.target_tenant string (uri)
rbac_policies.target_tenant_name string
rbac_policies.backend_id string
rbac_policies.policy_type any Type of access granted - either shared access or external network access
rbac_policies.created string (date-time)
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Partially update network

Update specific fields of a network.

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/openstack-networks/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_open_stack_network_request import PatchedOpenStackNetworkRequest # (1)
from waldur_api_client.api.openstack_networks import openstack_networks_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedOpenStackNetworkRequest()
response = openstack_networks_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedOpenStackNetworkRequest
  2. API Source: openstack_networks_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackNetworksPartialUpdate } from 'waldur-js-client';

try {
  const response = await openstackNetworksPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
name string
description string

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
tenant string (uri) OpenStack tenant this network belongs to
tenant_name string
tenant_uuid string (uuid)
is_external boolean Defines whether this network is external (public) or internal (private)
type string Network type, such as local, flat, vlan, vxlan, or gre
segmentation_id integer VLAN ID for VLAN networks or tunnel ID for VXLAN/GRE networks
subnets array of objects
subnets.uuid string (uuid)
subnets.name string
subnets.description string
subnets.cidr string IPv4 network address in CIDR format (e.g. 192.168.0.0/24)
subnets.gateway_ip any IP address of the gateway for this subnet
subnets.allocation_pools array of objects
subnets.allocation_pools.start any An IPv4 or IPv6 address.
subnets.allocation_pools.end any An IPv4 or IPv6 address.
subnets.ip_version integer IP protocol version (4 or 6)
subnets.enable_dhcp boolean If True, DHCP service will be enabled on this subnet
mtu integer The maximum transmission unit (MTU) value to address fragmentation.
rbac_policies array of objects
rbac_policies.url string (uri)
rbac_policies.uuid string (uuid)
rbac_policies.network string (uri)
rbac_policies.network_name string
rbac_policies.target_tenant string (uri)
rbac_policies.target_tenant_name string
rbac_policies.backend_id string
rbac_policies.policy_type any Type of access granted - either shared access or external network access
rbac_policies.created string (date-time)
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Delete network

Delete a network.

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/openstack-networks/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_networks import openstack_networks_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_networks_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openstack_networks_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackNetworksDestroy } from 'waldur-js-client';

try {
  const response = await openstackNetworksDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Other Actions

Create RBAC policy

Create RBAC policy for the network. DEPRECATED: please use the dedicated /api/openstack-network-rbac-policies/ endpoint.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/openstack-networks/a1b2c3d4-e5f6-7890-abcd-ef1234567890/rbac_policy_create/ \
  Authorization:"Token YOUR_API_TOKEN" \
  target_tenant="https://api.example.com/api/target-tenant/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.deprecated_network_rbac_policy_request import DeprecatedNetworkRBACPolicyRequest # (1)
from waldur_api_client.api.openstack_networks import openstack_networks_rbac_policy_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = DeprecatedNetworkRBACPolicyRequest(
    target_tenant="https://api.example.com/api/target-tenant/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = openstack_networks_rbac_policy_create.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: DeprecatedNetworkRBACPolicyRequest
  2. API Source: openstack_networks_rbac_policy_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { openstackNetworksRbacPolicyCreate } from 'waldur-js-client';

try {
  const response = await openstackNetworksRbacPolicyCreate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "target_tenant": "https://api.example.com/api/target-tenant/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
target_tenant string (uri) ✓
policy_type any Type of access granted - either shared access or external network access
Constraints: default: access_as_shared

200 -

Field Type Description
url string (uri)
uuid string (uuid)
network string (uri)
network_name string
target_tenant string (uri)
target_tenant_name string
backend_id string
policy_type any Type of access granted - either shared access or external network access
created string (date-time)

Mark resource as ERRED

Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.

1
2
3
4
http \
  POST \
  https://api.example.com/api/openstack-networks/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_erred/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.set_erred_request import SetErredRequest # (1)
from waldur_api_client.api.openstack_networks import openstack_networks_set_erred # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = SetErredRequest()
response = openstack_networks_set_erred.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: SetErredRequest
  2. API Source: openstack_networks_set_erred
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackNetworksSetErred } from 'waldur-js-client';

try {
  const response = await openstackNetworksSetErred({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
error_message string
error_traceback string

200 -

Field Type
detail string

Set network MTU

Update the Maximum Transmission Unit (MTU) for the network.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/openstack-networks/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_mtu/ \
  Authorization:"Token YOUR_API_TOKEN" \
  mtu=123

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.set_mtu_request import SetMtuRequest # (1)
from waldur_api_client.api.openstack_networks import openstack_networks_set_mtu # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = SetMtuRequest(
    mtu=123
)
response = openstack_networks_set_mtu.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: SetMtuRequest
  2. API Source: openstack_networks_set_mtu
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { openstackNetworksSetMtu } from 'waldur-js-client';

try {
  const response = await openstackNetworksSetMtu({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "mtu": 123
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
mtu integer ✓

200 -

Field Type
mtu integer

Mark resource as OK

Manually transition the resource to OK state and clear error fields. Staff-only operation.

1
2
3
4
http \
  POST \
  https://api.example.com/api/openstack-networks/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_ok/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_networks import openstack_networks_set_ok # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_networks_set_ok.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openstack_networks_set_ok
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackNetworksSetOk } from 'waldur-js-client';

try {
  const response = await openstackNetworksSetOk({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
detail string

Delete RBAC policy

Delete RBAC policy for the network. DEPRECATED: please use the dedicated /api/openstack-network-rbac-policies/ endpoint.

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/openstack-networks/a1b2c3d4-e5f6-7890-abcd-ef1234567890/rbac_policy_delete/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_networks import openstack_networks_rbac_policy_delete_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_networks_rbac_policy_delete_destroy.sync(
    rbac_policy_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openstack_networks_rbac_policy_delete_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { openstackNetworksRbacPolicyDeleteDestroy } from 'waldur-js-client';

try {
  const response = await openstackNetworksRbacPolicyDeleteDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "rbac_policy_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
rbac_policy_uuid string (uuid) ✓ UUID of the RBAC policy to delete
uuid string (uuid) ✓

204 - No response body

Openstack

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/openstack/discovery/ List Openstack Discovery
GET /api/openstack/discovery/{id}/ Retrieve
POST /api/openstack/discovery/ Create
PUT /api/openstack/discovery/{id}/ Update
PATCH /api/openstack/discovery/{id}/ Partial Update
DELETE /api/openstack/discovery/{id}/ Delete
Other Actions
POST /api/openstack/discovery/discover_external_networks/ Discover available external networks
POST /api/openstack/discovery/discover_flavors/ Discover available flavors
POST /api/openstack/discovery/discover_instance_availability_zones/ Discover available Nova instance availability zones
POST /api/openstack/discovery/discover_volume_availability_zones/ Discover available Cinder volume availability zones
POST /api/openstack/discovery/discover_volume_types/ Discover available volume types
POST /api/openstack/discovery/preview_service_attributes/ Build service_attributes and plugin_options from selected values
POST /api/openstack/discovery/validate_credentials/ Validate OpenStack credentials without saving them

Core CRUD

List Openstack Discovery

1
2
3
4
http \
  GET \
  https://api.example.com/api/openstack/discovery/ \
  Authorization:"Token YOUR_API_TOKEN"

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack import openstack_discovery_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_discovery_list.sync(client=client)

print(response)
  1. API Source: openstack_discovery_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { openstackDiscoveryList } from 'waldur-js-client';

try {
  const response = await openstackDiscoveryList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 - No response body

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/openstack/discovery/123/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack import openstack_discovery_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_discovery_retrieve.sync(
    id=123,
    client=client
)

print(response)
  1. API Source: openstack_discovery_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackDiscoveryRetrieve } from 'waldur-js-client';

try {
  const response = await openstackDiscoveryRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "id": 123
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
id integer ✓ A unique integer value identifying this Service provider.

200 - No response body

Create

1
2
3
4
http \
  POST \
  https://api.example.com/api/openstack/discovery/ \
  Authorization:"Token YOUR_API_TOKEN"

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack import openstack_discovery_create # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_discovery_create.sync(client=client)

print(response)
  1. API Source: openstack_discovery_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { openstackDiscoveryCreate } from 'waldur-js-client';

try {
  const response = await openstackDiscoveryCreate({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

201 - No response body

Update

1
2
3
4
http \
  PUT \
  https://api.example.com/api/openstack/discovery/123/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack import openstack_discovery_update # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_discovery_update.sync(
    id=123,
    client=client
)

print(response)
  1. API Source: openstack_discovery_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackDiscoveryUpdate } from 'waldur-js-client';

try {
  const response = await openstackDiscoveryUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "id": 123
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
id integer ✓ A unique integer value identifying this Service provider.

200 - No response body

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/openstack/discovery/123/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack import openstack_discovery_partial_update # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_discovery_partial_update.sync(
    id=123,
    client=client
)

print(response)
  1. API Source: openstack_discovery_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackDiscoveryPartialUpdate } from 'waldur-js-client';

try {
  const response = await openstackDiscoveryPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "id": 123
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
id integer ✓ A unique integer value identifying this Service provider.

200 - No response body

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/openstack/discovery/123/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack import openstack_discovery_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_discovery_destroy.sync(
    id=123,
    client=client
)

print(response)
  1. API Source: openstack_discovery_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackDiscoveryDestroy } from 'waldur-js-client';

try {
  const response = await openstackDiscoveryDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "id": 123
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
id integer ✓ A unique integer value identifying this Service provider.

204 - No response body

Other Actions

Discover available external networks

Discover available external networks.

1
2
3
4
5
6
7
http \
  POST \
  https://api.example.com/api/openstack/discovery/discover_external_networks/ \
  Authorization:"Token YOUR_API_TOKEN" \
  auth_url="https://api.example.com/api/auth-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  username="alice" \
  password="********"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.discover_external_networks_request_request import DiscoverExternalNetworksRequestRequest # (1)
from waldur_api_client.api.openstack import openstack_discovery_discover_external_networks # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = DiscoverExternalNetworksRequestRequest(
    auth_url="https://api.example.com/api/auth-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    username="alice",
    password="********"
)
response = openstack_discovery_discover_external_networks.sync(
    client=client,
    body=body_data
)

for item in response:
    print(item)
  1. Model Source: DiscoverExternalNetworksRequestRequest
  2. API Source: openstack_discovery_discover_external_networks
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
import { openstackDiscoveryDiscoverExternalNetworks } from 'waldur-js-client';

try {
  const response = await openstackDiscoveryDiscoverExternalNetworks({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "auth_url": "https://api.example.com/api/auth-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "username": "alice",
    "password": "********"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
Field Type Required Description
auth_url string (uri) ✓ Keystone auth URL (e.g., https://cloud.example.com:5000/v3)
username string ✓
password string ✓
Constraints: write-only
user_domain_name string Keystone user domain name
Constraints: default: Default
project_domain_name string Keystone project domain name
Constraints: default: Default
project_name string Keystone project (tenant) name
Constraints: default: admin
verify_ssl boolean
Constraints: default: False
certificate string PEM-encoded CA certificate for SSL verification
Constraints: write-only

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
id string
name string
is_shared boolean
subnets array of objects
subnets.id string
subnets.name string
subnets.cidr string
subnets.gateway_ip string
subnets.ip_version integer

Discover available flavors

Discover available flavors.

1
2
3
4
5
6
7
http \
  POST \
  https://api.example.com/api/openstack/discovery/discover_flavors/ \
  Authorization:"Token YOUR_API_TOKEN" \
  auth_url="https://api.example.com/api/auth-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  username="alice" \
  password="********"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.discover_flavors_request_request import DiscoverFlavorsRequestRequest # (1)
from waldur_api_client.api.openstack import openstack_discovery_discover_flavors # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = DiscoverFlavorsRequestRequest(
    auth_url="https://api.example.com/api/auth-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    username="alice",
    password="********"
)
response = openstack_discovery_discover_flavors.sync(
    client=client,
    body=body_data
)

for item in response:
    print(item)
  1. Model Source: DiscoverFlavorsRequestRequest
  2. API Source: openstack_discovery_discover_flavors
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
import { openstackDiscoveryDiscoverFlavors } from 'waldur-js-client';

try {
  const response = await openstackDiscoveryDiscoverFlavors({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "auth_url": "https://api.example.com/api/auth-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "username": "alice",
    "password": "********"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
Field Type Required Description
auth_url string (uri) ✓ Keystone auth URL (e.g., https://cloud.example.com:5000/v3)
username string ✓
password string ✓
Constraints: write-only
user_domain_name string Keystone user domain name
Constraints: default: Default
project_domain_name string Keystone project domain name
Constraints: default: Default
project_name string Keystone project (tenant) name
Constraints: default: admin
verify_ssl boolean
Constraints: default: False
certificate string PEM-encoded CA certificate for SSL verification
Constraints: write-only

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
id string
name string
vcpus integer
ram integer RAM in MB
disk integer Disk in GB

Discover available Nova instance availability zones

Discover available Nova instance availability zones.

1
2
3
4
5
6
7
http \
  POST \
  https://api.example.com/api/openstack/discovery/discover_instance_availability_zones/ \
  Authorization:"Token YOUR_API_TOKEN" \
  auth_url="https://api.example.com/api/auth-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  username="alice" \
  password="********"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.discover_instance_availability_zones_request_request import DiscoverInstanceAvailabilityZonesRequestRequest # (1)
from waldur_api_client.api.openstack import openstack_discovery_discover_instance_availability_zones # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = DiscoverInstanceAvailabilityZonesRequestRequest(
    auth_url="https://api.example.com/api/auth-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    username="alice",
    password="********"
)
response = openstack_discovery_discover_instance_availability_zones.sync(
    client=client,
    body=body_data
)

for item in response:
    print(item)
  1. Model Source: DiscoverInstanceAvailabilityZonesRequestRequest
  2. API Source: openstack_discovery_discover_instance_availability_zones
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
import { openstackDiscoveryDiscoverInstanceAvailabilityZones } from 'waldur-js-client';

try {
  const response = await openstackDiscoveryDiscoverInstanceAvailabilityZones({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "auth_url": "https://api.example.com/api/auth-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "username": "alice",
    "password": "********"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
Field Type Required Description
auth_url string (uri) ✓ Keystone auth URL (e.g., https://cloud.example.com:5000/v3)
username string ✓
password string ✓
Constraints: write-only
user_domain_name string Keystone user domain name
Constraints: default: Default
project_domain_name string Keystone project domain name
Constraints: default: Default
project_name string Keystone project (tenant) name
Constraints: default: admin
verify_ssl boolean
Constraints: default: False
certificate string PEM-encoded CA certificate for SSL verification
Constraints: write-only

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
name string
state string

Discover available Cinder volume availability zones

Discover available Cinder volume availability zones.

1
2
3
4
5
6
7
http \
  POST \
  https://api.example.com/api/openstack/discovery/discover_volume_availability_zones/ \
  Authorization:"Token YOUR_API_TOKEN" \
  auth_url="https://api.example.com/api/auth-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  username="alice" \
  password="********"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.discover_volume_availability_zones_request_request import DiscoverVolumeAvailabilityZonesRequestRequest # (1)
from waldur_api_client.api.openstack import openstack_discovery_discover_volume_availability_zones # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = DiscoverVolumeAvailabilityZonesRequestRequest(
    auth_url="https://api.example.com/api/auth-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    username="alice",
    password="********"
)
response = openstack_discovery_discover_volume_availability_zones.sync(
    client=client,
    body=body_data
)

for item in response:
    print(item)
  1. Model Source: DiscoverVolumeAvailabilityZonesRequestRequest
  2. API Source: openstack_discovery_discover_volume_availability_zones
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
import { openstackDiscoveryDiscoverVolumeAvailabilityZones } from 'waldur-js-client';

try {
  const response = await openstackDiscoveryDiscoverVolumeAvailabilityZones({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "auth_url": "https://api.example.com/api/auth-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "username": "alice",
    "password": "********"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
Field Type Required Description
auth_url string (uri) ✓ Keystone auth URL (e.g., https://cloud.example.com:5000/v3)
username string ✓
password string ✓
Constraints: write-only
user_domain_name string Keystone user domain name
Constraints: default: Default
project_domain_name string Keystone project domain name
Constraints: default: Default
project_name string Keystone project (tenant) name
Constraints: default: admin
verify_ssl boolean
Constraints: default: False
certificate string PEM-encoded CA certificate for SSL verification
Constraints: write-only

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
name string
state string

Discover available volume types

Discover available volume types.

1
2
3
4
5
6
7
http \
  POST \
  https://api.example.com/api/openstack/discovery/discover_volume_types/ \
  Authorization:"Token YOUR_API_TOKEN" \
  auth_url="https://api.example.com/api/auth-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  username="alice" \
  password="********"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.discover_volume_types_request_request import DiscoverVolumeTypesRequestRequest # (1)
from waldur_api_client.api.openstack import openstack_discovery_discover_volume_types # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = DiscoverVolumeTypesRequestRequest(
    auth_url="https://api.example.com/api/auth-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    username="alice",
    password="********"
)
response = openstack_discovery_discover_volume_types.sync(
    client=client,
    body=body_data
)

for item in response:
    print(item)
  1. Model Source: DiscoverVolumeTypesRequestRequest
  2. API Source: openstack_discovery_discover_volume_types
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
import { openstackDiscoveryDiscoverVolumeTypes } from 'waldur-js-client';

try {
  const response = await openstackDiscoveryDiscoverVolumeTypes({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "auth_url": "https://api.example.com/api/auth-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "username": "alice",
    "password": "********"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
Field Type Required Description
auth_url string (uri) ✓ Keystone auth URL (e.g., https://cloud.example.com:5000/v3)
username string ✓
password string ✓
Constraints: write-only
user_domain_name string Keystone user domain name
Constraints: default: Default
project_domain_name string Keystone project domain name
Constraints: default: Default
project_name string Keystone project (tenant) name
Constraints: default: admin
verify_ssl boolean
Constraints: default: False
certificate string PEM-encoded CA certificate for SSL verification
Constraints: write-only

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
id string
name string
description string

Build service_attributes and plugin_options from selected values

Build service_attributes and plugin_options from selected values.

1
2
3
4
5
6
7
http \
  POST \
  https://api.example.com/api/openstack/discovery/preview_service_attributes/ \
  Authorization:"Token YOUR_API_TOKEN" \
  auth_url="https://api.example.com/api/auth-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  username="alice" \
  password="********"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.preview_service_attributes_request_request import PreviewServiceAttributesRequestRequest # (1)
from waldur_api_client.api.openstack import openstack_discovery_preview_service_attributes # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PreviewServiceAttributesRequestRequest(
    auth_url="https://api.example.com/api/auth-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    username="alice",
    password="********"
)
response = openstack_discovery_preview_service_attributes.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PreviewServiceAttributesRequestRequest
  2. API Source: openstack_discovery_preview_service_attributes
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
import { openstackDiscoveryPreviewServiceAttributes } from 'waldur-js-client';

try {
  const response = await openstackDiscoveryPreviewServiceAttributes({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "auth_url": "https://api.example.com/api/auth-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "username": "alice",
    "password": "********"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
auth_url string (uri) ✓ Keystone auth URL (e.g., https://cloud.example.com:5000/v3)
username string ✓
password string ✓
Constraints: write-only
user_domain_name string Keystone user domain name
Constraints: default: Default
project_domain_name string Keystone project domain name
Constraints: default: Default
project_name string Keystone project (tenant) name
Constraints: default: admin
verify_ssl boolean
Constraints: default: False
certificate string PEM-encoded CA certificate for SSL verification
Constraints: write-only
external_network_id string Selected external network ID
Constraints: default: ``
instance_availability_zone string Selected instance availability zone name
Constraints: default: ``
volume_availability_zone string Selected volume availability zone name
Constraints: default: ``

200 -

Field Type
service_attributes object (free-form)
plugin_options object (free-form)

Validate OpenStack credentials without saving them

Validate OpenStack credentials without saving them.

1
2
3
4
5
6
7
http \
  POST \
  https://api.example.com/api/openstack/discovery/validate_credentials/ \
  Authorization:"Token YOUR_API_TOKEN" \
  auth_url="https://api.example.com/api/auth-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  username="alice" \
  password="********"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.open_stack_credentials_request import OpenStackCredentialsRequest # (1)
from waldur_api_client.api.openstack import openstack_discovery_validate_credentials # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OpenStackCredentialsRequest(
    auth_url="https://api.example.com/api/auth-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    username="alice",
    password="********"
)
response = openstack_discovery_validate_credentials.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OpenStackCredentialsRequest
  2. API Source: openstack_discovery_validate_credentials
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
import { openstackDiscoveryValidateCredentials } from 'waldur-js-client';

try {
  const response = await openstackDiscoveryValidateCredentials({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "auth_url": "https://api.example.com/api/auth-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "username": "alice",
    "password": "********"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
auth_url string (uri) ✓ Keystone auth URL (e.g., https://cloud.example.com:5000/v3)
username string ✓
password string ✓
Constraints: write-only
user_domain_name string Keystone user domain name
Constraints: default: Default
project_domain_name string Keystone project domain name
Constraints: default: Default
project_name string Keystone project (tenant) name
Constraints: default: admin
verify_ssl boolean
Constraints: default: False
certificate string PEM-encoded CA certificate for SSL verification
Constraints: write-only

200 -

Field Type
valid boolean
message string
error string
server_info any

Openstack Ports

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/openstack-ports/ List ports
GET /api/openstack-ports/{uuid}/ Get port details
POST /api/openstack-ports/ Create port
POST /api/openstack-ports/{uuid}/pull/ Synchronize resource state
POST /api/openstack-ports/{uuid}/unlink/ Unlink resource
POST /api/openstack-ports/{uuid}/update_port_ip/ Update port IP address
POST /api/openstack-ports/{uuid}/update_security_groups/ Update port security groups
PUT /api/openstack-ports/{uuid}/ Update port
PATCH /api/openstack-ports/{uuid}/ Partially update port
DELETE /api/openstack-ports/{uuid}/ Delete port
Other Actions
POST /api/openstack-ports/{uuid}/disable_port/ Disable port
POST /api/openstack-ports/{uuid}/disable_port_security/ Disable port security
POST /api/openstack-ports/{uuid}/enable_port/ Enable port
POST /api/openstack-ports/{uuid}/enable_port_security/ Enable port security
POST /api/openstack-ports/{uuid}/set_erred/ Mark resource as ERRED
POST /api/openstack-ports/{uuid}/set_ok/ Mark resource as OK

Core CRUD

List ports

Get a list of network ports.

1
2
3
4
http \
  GET \
  https://api.example.com/api/openstack-ports/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.open_stack_port_field_enum import OpenStackPortFieldEnum # (1)
from waldur_api_client.models.open_stack_port_o_enum import OpenStackPortOEnum # (2)
from waldur_api_client.api.openstack_ports import openstack_ports_list # (3)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_ports_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: OpenStackPortFieldEnum
  2. Model Source: OpenStackPortOEnum
  3. API Source: openstack_ports_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { openstackPortsList } from 'waldur-js-client';

try {
  const response = await openstackPortsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
admin_state_up boolean
backend_id string
device_id string
device_owner string
exclude_subnet_uuids string Exclude Subnet UUIDs (comma-separated)
field array
fixed_ips string Search by fixed IP
has_device_owner boolean Has device owner
mac_address string
name string Name
name_exact string Name (exact)
network_name string Search by network name
network_uuid string (uuid) Search by network UUID
o array Ordering
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
query string Search by name, MAC address or backend ID
status string
tenant string (uri) Tenant URL
tenant_uuid string (uuid) Tenant UUID

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string Port ID in OpenStack
access_url string
fixed_ips array of objects
fixed_ips.ip_address any IP address to assign to the port
fixed_ips.subnet_id string ID of the subnet in which to assign the IP address
mac_address string MAC address of the port
allowed_address_pairs array of objects
allowed_address_pairs.mac_address string
tenant string (uri) OpenStack tenant this port belongs to
tenant_name string
tenant_uuid string (uuid)
network string (uri) Network to which this port belongs
network_name string
network_uuid string (uuid)
floating_ips array of string (uri)s
device_id string ID of device (instance, router etc) to which this port is connected
device_owner string Entity that uses this port (e.g. network:router_interface)
port_security_enabled boolean If True, security groups and rules will be applied to this port
security_groups array of objects
security_groups.uuid string (uuid)
security_groups.name string
security_groups.url string (uri)
admin_state_up boolean Administrative state of the port. If down, port does not forward packets
status string Port status in OpenStack (e.g. ACTIVE, DOWN)
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Get port details

Retrieve details of a specific network port.

1
2
3
4
http \
  GET \
  https://api.example.com/api/openstack-ports/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.open_stack_port_field_enum import OpenStackPortFieldEnum # (1)
from waldur_api_client.api.openstack_ports import openstack_ports_retrieve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_ports_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. Model Source: OpenStackPortFieldEnum
  2. API Source: openstack_ports_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackPortsRetrieve } from 'waldur-js-client';

try {
  const response = await openstackPortsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type
field array

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string Port ID in OpenStack
access_url string
fixed_ips array of objects
fixed_ips.ip_address any IP address to assign to the port
fixed_ips.subnet_id string ID of the subnet in which to assign the IP address
mac_address string MAC address of the port
allowed_address_pairs array of objects
allowed_address_pairs.mac_address string
tenant string (uri) OpenStack tenant this port belongs to
tenant_name string
tenant_uuid string (uuid)
network string (uri) Network to which this port belongs
network_name string
network_uuid string (uuid)
floating_ips array of string (uri)s
device_id string ID of device (instance, router etc) to which this port is connected
device_owner string Entity that uses this port (e.g. network:router_interface)
port_security_enabled boolean If True, security groups and rules will be applied to this port
security_groups array of objects
security_groups.uuid string (uuid)
security_groups.name string
security_groups.url string (uri)
admin_state_up boolean Administrative state of the port. If down, port does not forward packets
status string Port status in OpenStack (e.g. ACTIVE, DOWN)
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Create port

Create a new network port.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/openstack-ports/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-openstack-port"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.open_stack_port_request import OpenStackPortRequest # (1)
from waldur_api_client.api.openstack_ports import openstack_ports_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OpenStackPortRequest(
    name="my-awesome-openstack-port"
)
response = openstack_ports_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OpenStackPortRequest
  2. API Source: openstack_ports_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackPortsCreate } from 'waldur-js-client';

try {
  const response = await openstackPortsCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "name": "my-awesome-openstack-port"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
name string ✓
description string
fixed_ips array of objects
fixed_ips.ip_address any ✓ IP address to assign to the port
fixed_ips.subnet_id string ✓ ID of the subnet in which to assign the IP address
mac_address string MAC address of the port
allowed_address_pairs array of objects
allowed_address_pairs.ip_address string
Constraints: write-only, default: 192.168.42.0/24
allowed_address_pairs.mac_address string
target_tenant string (uri) Target tenant for shared network port creation. If not specified, defaults to network's tenant.
Constraints: write-only
network string (uri) Network to which this port belongs
port_security_enabled boolean If True, security groups and rules will be applied to this port
security_groups array of objects
security_groups.name string ✓

201 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string Port ID in OpenStack
access_url string
fixed_ips array of objects
fixed_ips.ip_address any IP address to assign to the port
fixed_ips.subnet_id string ID of the subnet in which to assign the IP address
mac_address string MAC address of the port
allowed_address_pairs array of objects
allowed_address_pairs.mac_address string
tenant string (uri) OpenStack tenant this port belongs to
tenant_name string
tenant_uuid string (uuid)
network string (uri) Network to which this port belongs
network_name string
network_uuid string (uuid)
floating_ips array of string (uri)s
device_id string ID of device (instance, router etc) to which this port is connected
device_owner string Entity that uses this port (e.g. network:router_interface)
port_security_enabled boolean If True, security groups and rules will be applied to this port
security_groups array of objects
security_groups.uuid string (uuid)
security_groups.name string
security_groups.url string (uri)
admin_state_up boolean Administrative state of the port. If down, port does not forward packets
status string Port status in OpenStack (e.g. ACTIVE, DOWN)
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Synchronize resource state

Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.

1
2
3
4
http \
  POST \
  https://api.example.com/api/openstack-ports/a1b2c3d4-e5f6-7890-abcd-ef1234567890/pull/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_ports import openstack_ports_pull # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_ports_pull.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openstack_ports_pull
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackPortsPull } from 'waldur-js-client';

try {
  const response = await openstackPortsPull({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

202 -

Field Type
detail string

409 -

Field Type
detail string

Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state.

1
2
3
4
http \
  POST \
  https://api.example.com/api/openstack-ports/a1b2c3d4-e5f6-7890-abcd-ef1234567890/unlink/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_ports import openstack_ports_unlink # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_ports_unlink.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openstack_ports_unlink
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackPortsUnlink } from 'waldur-js-client';

try {
  const response = await openstackPortsUnlink({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Update port IP address

Update port IP address.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/openstack-ports/a1b2c3d4-e5f6-7890-abcd-ef1234567890/update_port_ip/ \
  Authorization:"Token YOUR_API_TOKEN" \
  subnet="https://api.example.com/api/subnet/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  ip_address="192.168.42.50"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.open_stack_port_ip_update_request import OpenStackPortIPUpdateRequest # (1)
from waldur_api_client.api.openstack_ports import openstack_ports_update_port_ip # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OpenStackPortIPUpdateRequest(
    subnet="https://api.example.com/api/subnet/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    ip_address="192.168.42.50"
)
response = openstack_ports_update_port_ip.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OpenStackPortIPUpdateRequest
  2. API Source: openstack_ports_update_port_ip
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { openstackPortsUpdatePortIp } from 'waldur-js-client';

try {
  const response = await openstackPortsUpdatePortIp({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "subnet": "https://api.example.com/api/subnet/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "ip_address": "192.168.42.50"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
subnet string (uri) ✓ The subnet where the new IP address will be allocated
Constraints: write-only
ip_address any ✓ The IP address to assign within the subnet

200 - No response body

Update port security groups

Update security groups of the port

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/openstack-ports/a1b2c3d4-e5f6-7890-abcd-ef1234567890/update_security_groups/ \
  Authorization:"Token YOUR_API_TOKEN" \
  security_groups:='["web-server-sg"]'

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.open_stack_instance_security_groups_update_request import OpenStackInstanceSecurityGroupsUpdateRequest # (1)
from waldur_api_client.api.openstack_ports import openstack_ports_update_security_groups # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OpenStackInstanceSecurityGroupsUpdateRequest(
    security_groups=[
            "web-server-sg"
        ]
)
response = openstack_ports_update_security_groups.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OpenStackInstanceSecurityGroupsUpdateRequest
  2. API Source: openstack_ports_update_security_groups
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
import { openstackPortsUpdateSecurityGroups } from 'waldur-js-client';

try {
  const response = await openstackPortsUpdateSecurityGroups({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "security_groups": [
      "web-server-sg"
    ]
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
security_groups array of string (uri)s ✓ List of security groups to be assigned to the instance.

200 - No response body

Update port

Update an existing network port.

1
2
3
4
5
http \
  PUT \
  https://api.example.com/api/openstack-ports/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-openstack-port"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.open_stack_port_request import OpenStackPortRequest # (1)
from waldur_api_client.api.openstack_ports import openstack_ports_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OpenStackPortRequest(
    name="my-awesome-openstack-port"
)
response = openstack_ports_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OpenStackPortRequest
  2. API Source: openstack_ports_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { openstackPortsUpdate } from 'waldur-js-client';

try {
  const response = await openstackPortsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-openstack-port"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
name string ✓
description string
fixed_ips array of objects
fixed_ips.ip_address any ✓ IP address to assign to the port
fixed_ips.subnet_id string ✓ ID of the subnet in which to assign the IP address
mac_address string MAC address of the port
allowed_address_pairs array of objects
allowed_address_pairs.ip_address string
Constraints: write-only, default: 192.168.42.0/24
allowed_address_pairs.mac_address string
target_tenant string (uri) Target tenant for shared network port creation. If not specified, defaults to network's tenant.
Constraints: write-only
network string (uri) Network to which this port belongs
port_security_enabled boolean If True, security groups and rules will be applied to this port
security_groups array of objects
security_groups.name string ✓

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string Port ID in OpenStack
access_url string
fixed_ips array of objects
fixed_ips.ip_address any IP address to assign to the port
fixed_ips.subnet_id string ID of the subnet in which to assign the IP address
mac_address string MAC address of the port
allowed_address_pairs array of objects
allowed_address_pairs.mac_address string
tenant string (uri) OpenStack tenant this port belongs to
tenant_name string
tenant_uuid string (uuid)
network string (uri) Network to which this port belongs
network_name string
network_uuid string (uuid)
floating_ips array of string (uri)s
device_id string ID of device (instance, router etc) to which this port is connected
device_owner string Entity that uses this port (e.g. network:router_interface)
port_security_enabled boolean If True, security groups and rules will be applied to this port
security_groups array of objects
security_groups.uuid string (uuid)
security_groups.name string
security_groups.url string (uri)
admin_state_up boolean Administrative state of the port. If down, port does not forward packets
status string Port status in OpenStack (e.g. ACTIVE, DOWN)
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Partially update port

Update specific fields of a network port.

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/openstack-ports/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_open_stack_port_request import PatchedOpenStackPortRequest # (1)
from waldur_api_client.api.openstack_ports import openstack_ports_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedOpenStackPortRequest()
response = openstack_ports_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedOpenStackPortRequest
  2. API Source: openstack_ports_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackPortsPartialUpdate } from 'waldur-js-client';

try {
  const response = await openstackPortsPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
name string
description string
target_tenant string (uri) Target tenant for shared network port creation. If not specified, defaults to network's tenant.
Constraints: write-only
security_groups array of objects
security_groups.name string ✓

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string Port ID in OpenStack
access_url string
fixed_ips array of objects
fixed_ips.ip_address any IP address to assign to the port
fixed_ips.subnet_id string ID of the subnet in which to assign the IP address
mac_address string MAC address of the port
allowed_address_pairs array of objects
allowed_address_pairs.mac_address string
tenant string (uri) OpenStack tenant this port belongs to
tenant_name string
tenant_uuid string (uuid)
network string (uri) Network to which this port belongs
network_name string
network_uuid string (uuid)
floating_ips array of string (uri)s
device_id string ID of device (instance, router etc) to which this port is connected
device_owner string Entity that uses this port (e.g. network:router_interface)
port_security_enabled boolean If True, security groups and rules will be applied to this port
security_groups array of objects
security_groups.uuid string (uuid)
security_groups.name string
security_groups.url string (uri)
admin_state_up boolean Administrative state of the port. If down, port does not forward packets
status string Port status in OpenStack (e.g. ACTIVE, DOWN)
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Delete port

Delete a network port.

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/openstack-ports/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_ports import openstack_ports_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_ports_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openstack_ports_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackPortsDestroy } from 'waldur-js-client';

try {
  const response = await openstackPortsDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Other Actions

Disable port

Disable port.

1
2
3
4
http \
  POST \
  https://api.example.com/api/openstack-ports/a1b2c3d4-e5f6-7890-abcd-ef1234567890/disable_port/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_ports import openstack_ports_disable_port # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_ports_disable_port.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openstack_ports_disable_port
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackPortsDisablePort } from 'waldur-js-client';

try {
  const response = await openstackPortsDisablePort({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 - No response body

Disable port security

Disable port security for the port

1
2
3
4
http \
  POST \
  https://api.example.com/api/openstack-ports/a1b2c3d4-e5f6-7890-abcd-ef1234567890/disable_port_security/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_ports import openstack_ports_disable_port_security # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_ports_disable_port_security.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openstack_ports_disable_port_security
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackPortsDisablePortSecurity } from 'waldur-js-client';

try {
  const response = await openstackPortsDisablePortSecurity({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 - No response body

Enable port

Enable port.

1
2
3
4
http \
  POST \
  https://api.example.com/api/openstack-ports/a1b2c3d4-e5f6-7890-abcd-ef1234567890/enable_port/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_ports import openstack_ports_enable_port # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_ports_enable_port.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openstack_ports_enable_port
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackPortsEnablePort } from 'waldur-js-client';

try {
  const response = await openstackPortsEnablePort({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 - No response body

Enable port security

Enable port security for the port

1
2
3
4
http \
  POST \
  https://api.example.com/api/openstack-ports/a1b2c3d4-e5f6-7890-abcd-ef1234567890/enable_port_security/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_ports import openstack_ports_enable_port_security # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_ports_enable_port_security.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openstack_ports_enable_port_security
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackPortsEnablePortSecurity } from 'waldur-js-client';

try {
  const response = await openstackPortsEnablePortSecurity({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 - No response body

Mark resource as ERRED

Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.

1
2
3
4
http \
  POST \
  https://api.example.com/api/openstack-ports/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_erred/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.set_erred_request import SetErredRequest # (1)
from waldur_api_client.api.openstack_ports import openstack_ports_set_erred # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = SetErredRequest()
response = openstack_ports_set_erred.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: SetErredRequest
  2. API Source: openstack_ports_set_erred
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackPortsSetErred } from 'waldur-js-client';

try {
  const response = await openstackPortsSetErred({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
error_message string
error_traceback string

200 -

Field Type
detail string

Mark resource as OK

Manually transition the resource to OK state and clear error fields. Staff-only operation.

1
2
3
4
http \
  POST \
  https://api.example.com/api/openstack-ports/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_ok/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_ports import openstack_ports_set_ok # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_ports_set_ok.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openstack_ports_set_ok
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackPortsSetOk } from 'waldur-js-client';

try {
  const response = await openstackPortsSetOk({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
detail string

Openstack Routers

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/openstack-routers/ List routers
GET /api/openstack-routers/{uuid}/ Get router details
POST /api/openstack-routers/ Create router
DELETE /api/openstack-routers/{uuid}/ Delete router
Other Actions
POST /api/openstack-routers/{uuid}/add_router_interface/ Add router interface
POST /api/openstack-routers/{uuid}/remove_router_interface/ Remove router interface
POST /api/openstack-routers/{uuid}/set_erred/ Mark router as ERRED
POST /api/openstack-routers/{uuid}/set_ok/ Mark router as OK
POST /api/openstack-routers/{uuid}/set_routes/ Set static routes

Core CRUD

List routers

Get a list of routers.

1
2
3
4
http \
  GET \
  https://api.example.com/api/openstack-routers/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.core_states import CoreStates # (1)
from waldur_api_client.models.open_stack_router_field_enum import OpenStackRouterFieldEnum # (2)
from waldur_api_client.api.openstack_routers import openstack_routers_list # (3)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_routers_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: CoreStates
  2. Model Source: OpenStackRouterFieldEnum
  3. API Source: openstack_routers_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { openstackRoutersList } from 'waldur-js-client';

try {
  const response = await openstackRoutersList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
field array
name string Name
name_exact string Name (exact)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
state array State
tenant string (uri) Tenant URL
tenant_uuid string (uuid) Tenant UUID

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string Router ID in OpenStack
access_url string
tenant string (uri) OpenStack tenant this router belongs to
tenant_name string
tenant_uuid string (uuid)
routes array of objects
routes.destination string
routes.nexthop any An IPv4 or IPv6 address.
fixed_ips array of objects
fixed_ips.ip_address any IP address to assign to the port
fixed_ips.subnet_id string ID of the subnet in which to assign the IP address
ports array of objects
ports.url string (uri)
ports.fixed_ips array of objects
ports.fixed_ips.ip_address any IP address to assign to the port
ports.fixed_ips.subnet_id string ID of the subnet in which to assign the IP address
ports.mac_address string MAC address of the port
ports.subnet string (uri) Subnet to which this port belongs
ports.subnet_uuid string (uuid)
ports.subnet_name string
ports.subnet_description string
ports.subnet_cidr string IPv4 network address in CIDR format (e.g. 192.168.0.0/24)
ports.allowed_address_pairs array of objects
ports.allowed_address_pairs.mac_address string
ports.device_id string ID of device (instance, router etc) to which this port is connected
ports.device_owner string Entity that uses this port (e.g. network:router_interface)
ports.security_groups array of objects
ports.security_groups.url string (uri)
ports.security_groups.uuid string (uuid)
ports.security_groups.name string
ports.security_groups.description string
ports.security_groups.service_name string
ports.security_groups.service_settings string (uri)
ports.security_groups.service_settings_uuid string (uuid)
ports.security_groups.service_settings_state string
ports.security_groups.service_settings_error_message string
ports.security_groups.project string (uri)
ports.security_groups.project_name string
ports.security_groups.project_uuid string (uuid)
ports.security_groups.customer string (uri)
ports.security_groups.customer_uuid string (uuid)
ports.security_groups.customer_name string
ports.security_groups.customer_native_name string
ports.security_groups.customer_abbreviation string
ports.security_groups.error_message string
ports.security_groups.error_traceback string
ports.security_groups.resource_type string
ports.security_groups.state any
ports.security_groups.created string (date-time)
ports.security_groups.modified string (date-time)
ports.security_groups.backend_id string
ports.security_groups.access_url string
ports.security_groups.tenant string (uri)
ports.security_groups.tenant_name string
ports.security_groups.tenant_uuid string (uuid)
ports.security_groups.rules array of objects
ports.security_groups.rules.ethertype any IP protocol version - either 'IPv4' or 'IPv6'
ports.security_groups.rules.direction any Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing)
ports.security_groups.rules.protocol any The network protocol (TCP, UDP, ICMP, or empty for any protocol)
ports.security_groups.rules.from_port integer Starting port number in the range (1-65535)
ports.security_groups.rules.to_port integer Ending port number in the range (1-65535)
ports.security_groups.rules.cidr string CIDR notation for the source/destination network address range
ports.security_groups.rules.description string
ports.security_groups.rules.remote_group_name string
ports.security_groups.rules.remote_group_uuid string (uuid)
ports.security_groups.rules.id integer
ports.security_groups.rules.remote_group string (uri) Remote security group that this rule references, if any
ports.security_groups.marketplace_offering_uuid string
ports.security_groups.marketplace_offering_name string
ports.security_groups.marketplace_offering_plugin_options object (free-form)
ports.security_groups.marketplace_category_uuid string
ports.security_groups.marketplace_category_name string
ports.security_groups.marketplace_resource_uuid string
ports.security_groups.marketplace_plan_uuid string
ports.security_groups.marketplace_resource_state string
ports.security_groups.is_usage_based boolean
ports.security_groups.is_limit_based boolean
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean
offering_external_ips array of strings

Get router details

Retrieve details of a specific router.

1
2
3
4
http \
  GET \
  https://api.example.com/api/openstack-routers/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.open_stack_router_field_enum import OpenStackRouterFieldEnum # (1)
from waldur_api_client.api.openstack_routers import openstack_routers_retrieve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_routers_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. Model Source: OpenStackRouterFieldEnum
  2. API Source: openstack_routers_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackRoutersRetrieve } from 'waldur-js-client';

try {
  const response = await openstackRoutersRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type
field array

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string Router ID in OpenStack
access_url string
tenant string (uri) OpenStack tenant this router belongs to
tenant_name string
tenant_uuid string (uuid)
routes array of objects
routes.destination string
routes.nexthop any An IPv4 or IPv6 address.
fixed_ips array of objects
fixed_ips.ip_address any IP address to assign to the port
fixed_ips.subnet_id string ID of the subnet in which to assign the IP address
ports array of objects
ports.url string (uri)
ports.fixed_ips array of objects
ports.fixed_ips.ip_address any IP address to assign to the port
ports.fixed_ips.subnet_id string ID of the subnet in which to assign the IP address
ports.mac_address string MAC address of the port
ports.subnet string (uri) Subnet to which this port belongs
ports.subnet_uuid string (uuid)
ports.subnet_name string
ports.subnet_description string
ports.subnet_cidr string IPv4 network address in CIDR format (e.g. 192.168.0.0/24)
ports.allowed_address_pairs array of objects
ports.allowed_address_pairs.mac_address string
ports.device_id string ID of device (instance, router etc) to which this port is connected
ports.device_owner string Entity that uses this port (e.g. network:router_interface)
ports.security_groups array of objects
ports.security_groups.url string (uri)
ports.security_groups.uuid string (uuid)
ports.security_groups.name string
ports.security_groups.description string
ports.security_groups.service_name string
ports.security_groups.service_settings string (uri)
ports.security_groups.service_settings_uuid string (uuid)
ports.security_groups.service_settings_state string
ports.security_groups.service_settings_error_message string
ports.security_groups.project string (uri)
ports.security_groups.project_name string
ports.security_groups.project_uuid string (uuid)
ports.security_groups.customer string (uri)
ports.security_groups.customer_uuid string (uuid)
ports.security_groups.customer_name string
ports.security_groups.customer_native_name string
ports.security_groups.customer_abbreviation string
ports.security_groups.error_message string
ports.security_groups.error_traceback string
ports.security_groups.resource_type string
ports.security_groups.state any
ports.security_groups.created string (date-time)
ports.security_groups.modified string (date-time)
ports.security_groups.backend_id string
ports.security_groups.access_url string
ports.security_groups.tenant string (uri)
ports.security_groups.tenant_name string
ports.security_groups.tenant_uuid string (uuid)
ports.security_groups.rules array of objects
ports.security_groups.rules.ethertype any IP protocol version - either 'IPv4' or 'IPv6'
ports.security_groups.rules.direction any Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing)
ports.security_groups.rules.protocol any The network protocol (TCP, UDP, ICMP, or empty for any protocol)
ports.security_groups.rules.from_port integer Starting port number in the range (1-65535)
ports.security_groups.rules.to_port integer Ending port number in the range (1-65535)
ports.security_groups.rules.cidr string CIDR notation for the source/destination network address range
ports.security_groups.rules.description string
ports.security_groups.rules.remote_group_name string
ports.security_groups.rules.remote_group_uuid string (uuid)
ports.security_groups.rules.id integer
ports.security_groups.rules.remote_group string (uri) Remote security group that this rule references, if any
ports.security_groups.marketplace_offering_uuid string
ports.security_groups.marketplace_offering_name string
ports.security_groups.marketplace_offering_plugin_options object (free-form)
ports.security_groups.marketplace_category_uuid string
ports.security_groups.marketplace_category_name string
ports.security_groups.marketplace_resource_uuid string
ports.security_groups.marketplace_plan_uuid string
ports.security_groups.marketplace_resource_state string
ports.security_groups.is_usage_based boolean
ports.security_groups.is_limit_based boolean
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean
offering_external_ips array of strings

Create router

Create a new router.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/openstack-routers/ \
  Authorization:"Token YOUR_API_TOKEN" \
  tenant="https://api.example.com/api/tenant/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  name="my-awesome-openstack-router"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.create_router_request import CreateRouterRequest # (1)
from waldur_api_client.api.openstack_routers import openstack_routers_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = CreateRouterRequest(
    tenant="https://api.example.com/api/tenant/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    name="my-awesome-openstack-router"
)
response = openstack_routers_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: CreateRouterRequest
  2. API Source: openstack_routers_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { openstackRoutersCreate } from 'waldur-js-client';

try {
  const response = await openstackRoutersCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "tenant": "https://api.example.com/api/tenant/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "name": "my-awesome-openstack-router"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
tenant string (uri) ✓ OpenStack tenant this router belongs to
name string ✓

201 -

Field Type Description
url string (uri)
uuid string (uuid)
tenant string (uri) OpenStack tenant this router belongs to
name string
project string (uri)
service_settings string (uri)

Delete router

Delete a router.

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/openstack-routers/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_routers import openstack_routers_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_routers_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openstack_routers_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackRoutersDestroy } from 'waldur-js-client';

try {
  const response = await openstackRoutersDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Other Actions

Add router interface

Add interface to router. Either subnet or port must be provided.

1
2
3
4
http \
  POST \
  https://api.example.com/api/openstack-routers/a1b2c3d4-e5f6-7890-abcd-ef1234567890/add_router_interface/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.open_stack_router_interface_request import OpenStackRouterInterfaceRequest # (1)
from waldur_api_client.api.openstack_routers import openstack_routers_add_router_interface # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OpenStackRouterInterfaceRequest()
response = openstack_routers_add_router_interface.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OpenStackRouterInterfaceRequest
  2. API Source: openstack_routers_add_router_interface
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackRoutersAddRouterInterface } from 'waldur-js-client';

try {
  const response = await openstackRoutersAddRouterInterface({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
subnet string (uri) The subnet to connect to the router. Either subnet or port must be specified, but not both.
port string (uri) The port to connect to the router. Either subnet or port must be specified, but not both.

200 - No response body

Remove router interface

Remove interface from router. Either subnet or port must be provided.

1
2
3
4
http \
  POST \
  https://api.example.com/api/openstack-routers/a1b2c3d4-e5f6-7890-abcd-ef1234567890/remove_router_interface/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.open_stack_router_interface_request import OpenStackRouterInterfaceRequest # (1)
from waldur_api_client.api.openstack_routers import openstack_routers_remove_router_interface # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OpenStackRouterInterfaceRequest()
response = openstack_routers_remove_router_interface.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OpenStackRouterInterfaceRequest
  2. API Source: openstack_routers_remove_router_interface
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackRoutersRemoveRouterInterface } from 'waldur-js-client';

try {
  const response = await openstackRoutersRemoveRouterInterface({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
subnet string (uri) The subnet to connect to the router. Either subnet or port must be specified, but not both.
port string (uri) The port to connect to the router. Either subnet or port must be specified, but not both.

200 - No response body

Mark router as ERRED

Manually transition the router to ERRED state. This is useful for routers stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.

1
2
3
4
http \
  POST \
  https://api.example.com/api/openstack-routers/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_erred/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.set_erred_request import SetErredRequest # (1)
from waldur_api_client.api.openstack_routers import openstack_routers_set_erred # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = SetErredRequest()
response = openstack_routers_set_erred.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: SetErredRequest
  2. API Source: openstack_routers_set_erred
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackRoutersSetErred } from 'waldur-js-client';

try {
  const response = await openstackRoutersSetErred({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
error_message string
error_traceback string

200 -

Field Type
detail string

Mark router as OK

Manually transition the router to OK state and clear error fields. Staff-only operation.

1
2
3
4
http \
  POST \
  https://api.example.com/api/openstack-routers/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_ok/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_routers import openstack_routers_set_ok # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_routers_set_ok.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openstack_routers_set_ok
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackRoutersSetOk } from 'waldur-js-client';

try {
  const response = await openstackRoutersSetOk({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
detail string

Set static routes

Define or overwrite the static routes for the router.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/openstack-routers/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_routes/ \
  Authorization:"Token YOUR_API_TOKEN" \
  routes:='[]'

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.open_stack_router_set_routes_request import OpenStackRouterSetRoutesRequest # (1)
from waldur_api_client.api.openstack_routers import openstack_routers_set_routes # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OpenStackRouterSetRoutesRequest(
    routes=[]
)
response = openstack_routers_set_routes.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OpenStackRouterSetRoutesRequest
  2. API Source: openstack_routers_set_routes
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { openstackRoutersSetRoutes } from 'waldur-js-client';

try {
  const response = await openstackRoutersSetRoutes({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "routes": []
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
routes array of objects ✓
routes.destination string ✓
routes.nexthop any ✓ An IPv4 or IPv6 address.

200 -

Field Type Description
routes array of objects
routes.destination string
routes.nexthop any An IPv4 or IPv6 address.

Openstack Security Groups

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/openstack-security-groups/ List security groups
GET /api/openstack-security-groups/{uuid}/ Get security group details
POST /api/openstack-security-groups/{uuid}/pull/ Synchronize resource state
POST /api/openstack-security-groups/{uuid}/unlink/ Unlink resource
PUT /api/openstack-security-groups/{uuid}/ Update
PATCH /api/openstack-security-groups/{uuid}/ Partially update security group
DELETE /api/openstack-security-groups/{uuid}/ Delete security group
Other Actions
POST /api/openstack-security-groups/{uuid}/set_erred/ Mark resource as ERRED
POST /api/openstack-security-groups/{uuid}/set_ok/ Mark resource as OK
POST /api/openstack-security-groups/{uuid}/set_rules/ Set security group rules

Core CRUD

List security groups

Get a list of security groups.

1
2
3
4
http \
  GET \
  https://api.example.com/api/openstack-security-groups/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.core_states import CoreStates # (1)
from waldur_api_client.models.open_stack_security_group_field_enum import OpenStackSecurityGroupFieldEnum # (2)
from waldur_api_client.api.openstack_security_groups import openstack_security_groups_list # (3)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_security_groups_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: CoreStates
  2. Model Source: OpenStackSecurityGroupFieldEnum
  3. API Source: openstack_security_groups_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { openstackSecurityGroupsList } from 'waldur-js-client';

try {
  const response = await openstackSecurityGroupsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
backend_id string Backend ID
can_manage boolean Can manage
customer string (uuid) Customer UUID
customer_abbreviation string Customer abbreviation
customer_name string Customer name
customer_native_name string Customer native name
customer_uuid string (uuid) Customer UUID
description string Description
external_ip string External IP
field array
name string Name
name_exact string Name (exact)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
project string (uuid) Project UUID
project_name string Project name
project_uuid string (uuid) Project UUID
query string Search by name or description
service_settings_name string Service settings name
service_settings_uuid string (uuid) Service settings UUID
state array State
tenant string (uri) Tenant URL
tenant_uuid string (uuid) Tenant UUID
uuid string (uuid) UUID

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
tenant string (uri)
tenant_name string
tenant_uuid string (uuid)
rules array of objects
rules.ethertype any IP protocol version - either 'IPv4' or 'IPv6'
rules.direction any Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing)
rules.protocol any The network protocol (TCP, UDP, ICMP, or empty for any protocol)
rules.from_port integer Starting port number in the range (1-65535)
rules.to_port integer Ending port number in the range (1-65535)
rules.cidr string CIDR notation for the source/destination network address range
rules.description string
rules.remote_group_name string
rules.remote_group_uuid string (uuid)
rules.id integer
rules.remote_group string (uri) Remote security group that this rule references, if any
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Get security group details

Retrieve details of a specific security group.

1
2
3
4
http \
  GET \
  https://api.example.com/api/openstack-security-groups/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.open_stack_security_group_field_enum import OpenStackSecurityGroupFieldEnum # (1)
from waldur_api_client.api.openstack_security_groups import openstack_security_groups_retrieve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_security_groups_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. Model Source: OpenStackSecurityGroupFieldEnum
  2. API Source: openstack_security_groups_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackSecurityGroupsRetrieve } from 'waldur-js-client';

try {
  const response = await openstackSecurityGroupsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type
field array

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
tenant string (uri)
tenant_name string
tenant_uuid string (uuid)
rules array of objects
rules.ethertype any IP protocol version - either 'IPv4' or 'IPv6'
rules.direction any Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing)
rules.protocol any The network protocol (TCP, UDP, ICMP, or empty for any protocol)
rules.from_port integer Starting port number in the range (1-65535)
rules.to_port integer Ending port number in the range (1-65535)
rules.cidr string CIDR notation for the source/destination network address range
rules.description string
rules.remote_group_name string
rules.remote_group_uuid string (uuid)
rules.id integer
rules.remote_group string (uri) Remote security group that this rule references, if any
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Synchronize resource state

Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.

1
2
3
4
http \
  POST \
  https://api.example.com/api/openstack-security-groups/a1b2c3d4-e5f6-7890-abcd-ef1234567890/pull/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_security_groups import openstack_security_groups_pull # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_security_groups_pull.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openstack_security_groups_pull
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackSecurityGroupsPull } from 'waldur-js-client';

try {
  const response = await openstackSecurityGroupsPull({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

202 -

Field Type
detail string

409 -

Field Type
detail string

Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state.

1
2
3
4
http \
  POST \
  https://api.example.com/api/openstack-security-groups/a1b2c3d4-e5f6-7890-abcd-ef1234567890/unlink/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_security_groups import openstack_security_groups_unlink # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_security_groups_unlink.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openstack_security_groups_unlink
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackSecurityGroupsUnlink } from 'waldur-js-client';

try {
  const response = await openstackSecurityGroupsUnlink({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Update

1
2
3
4
5
http \
  PUT \
  https://api.example.com/api/openstack-security-groups/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-openstack-security-group"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.open_stack_security_group_update_request import OpenStackSecurityGroupUpdateRequest # (1)
from waldur_api_client.api.openstack_security_groups import openstack_security_groups_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OpenStackSecurityGroupUpdateRequest(
    name="my-awesome-openstack-security-group"
)
response = openstack_security_groups_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OpenStackSecurityGroupUpdateRequest
  2. API Source: openstack_security_groups_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { openstackSecurityGroupsUpdate } from 'waldur-js-client';

try {
  const response = await openstackSecurityGroupsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-openstack-security-group"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
name string ✓
description string

200 -

Field Type
name string
description string

Partially update security group

Update specific fields of a security group.

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/openstack-security-groups/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_open_stack_security_group_update_request import PatchedOpenStackSecurityGroupUpdateRequest # (1)
from waldur_api_client.api.openstack_security_groups import openstack_security_groups_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedOpenStackSecurityGroupUpdateRequest()
response = openstack_security_groups_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedOpenStackSecurityGroupUpdateRequest
  2. API Source: openstack_security_groups_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackSecurityGroupsPartialUpdate } from 'waldur-js-client';

try {
  const response = await openstackSecurityGroupsPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
name string
description string

200 -

Field Type
name string
description string

Delete security group

Delete a security group.

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/openstack-security-groups/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_security_groups import openstack_security_groups_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_security_groups_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openstack_security_groups_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackSecurityGroupsDestroy } from 'waldur-js-client';

try {
  const response = await openstackSecurityGroupsDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Other Actions

Mark resource as ERRED

Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.

1
2
3
4
http \
  POST \
  https://api.example.com/api/openstack-security-groups/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_erred/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.set_erred_request import SetErredRequest # (1)
from waldur_api_client.api.openstack_security_groups import openstack_security_groups_set_erred # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = SetErredRequest()
response = openstack_security_groups_set_erred.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: SetErredRequest
  2. API Source: openstack_security_groups_set_erred
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackSecurityGroupsSetErred } from 'waldur-js-client';

try {
  const response = await openstackSecurityGroupsSetErred({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
error_message string
error_traceback string

200 -

Field Type
detail string

Mark resource as OK

Manually transition the resource to OK state and clear error fields. Staff-only operation.

1
2
3
4
http \
  POST \
  https://api.example.com/api/openstack-security-groups/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_ok/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_security_groups import openstack_security_groups_set_ok # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_security_groups_set_ok.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openstack_security_groups_set_ok
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackSecurityGroupsSetOk } from 'waldur-js-client';

try {
  const response = await openstackSecurityGroupsSetOk({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
detail string

Set security group rules

Update the rules for a specific security group. This overwrites all existing rules.

1
2
3
4
echo '[{"ethertype": null, "direction": null, "protocol": null, "from_port": 8080, "to_port": 8080, "cidr": "192.168.1.0/24", "description": "A sample description.", "remote_group": "https://api.example.com/api/remote-group/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"}]' | http \
  POST \
  https://api.example.com/api/openstack-security-groups/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_rules/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_security_groups import openstack_security_groups_set_rules # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_security_groups_set_rules.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openstack_security_groups_set_rules
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { openstackSecurityGroupsSetRules } from 'waldur-js-client';

try {
  const response = await openstackSecurityGroupsSetRules({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: [{"ethertype": null, "direction": null, "protocol": null, "from_port": 8080, "to_port": 8080, "cidr": "192.168.1.0/24", "description": "A sample description.", "remote_group": "https://api.example.com/api/remote-group/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"}]
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

The request body is an array of objects, where each object has the following structure:

Field Type Required Description
ethertype any IP protocol version - either 'IPv4' or 'IPv6'
Constraints: default: IPv4
direction any Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing)
Constraints: default: ingress
protocol any The network protocol (TCP, UDP, ICMP, or empty for any protocol)
from_port integer Starting port number in the range (1-65535)
to_port integer Ending port number in the range (1-65535)
cidr string CIDR notation for the source/destination network address range
description string
remote_group string (uri) Remote security group that this rule references, if any

200 - No response body

Openstack Server Groups

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/openstack-server-groups/ List server groups
GET /api/openstack-server-groups/{uuid}/ Get server group details
POST /api/openstack-server-groups/ Create
POST /api/openstack-server-groups/{uuid}/pull/ Synchronize resource state
POST /api/openstack-server-groups/{uuid}/unlink/ Unlink resource
DELETE /api/openstack-server-groups/{uuid}/ Delete server group
Other Actions
POST /api/openstack-server-groups/{uuid}/set_erred/ Mark resource as ERRED
POST /api/openstack-server-groups/{uuid}/set_ok/ Mark resource as OK

Core CRUD

List server groups

Get a list of server groups.

1
2
3
4
http \
  GET \
  https://api.example.com/api/openstack-server-groups/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.core_states import CoreStates # (1)
from waldur_api_client.models.open_stack_server_group_field_enum import OpenStackServerGroupFieldEnum # (2)
from waldur_api_client.api.openstack_server_groups import openstack_server_groups_list # (3)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_server_groups_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: CoreStates
  2. Model Source: OpenStackServerGroupFieldEnum
  3. API Source: openstack_server_groups_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { openstackServerGroupsList } from 'waldur-js-client';

try {
  const response = await openstackServerGroupsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
backend_id string Backend ID
can_manage boolean Can manage
customer string (uuid) Customer UUID
customer_abbreviation string Customer abbreviation
customer_name string Customer name
customer_native_name string Customer native name
customer_uuid string (uuid) Customer UUID
description string Description
external_ip string External IP
field array
name string Name
name_exact string Name (exact)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
project string (uuid) Project UUID
project_name string Project name
project_uuid string (uuid) Project UUID
service_settings_name string Service settings name
service_settings_uuid string (uuid) Service settings UUID
state array State
tenant string (uri) Tenant URL
tenant_uuid string (uuid) Tenant UUID
uuid string (uuid) UUID

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
tenant string (uri)
tenant_name string
tenant_uuid string (uuid)
policy any affinity — all instances are placed on the same hypervisor. anti-affinity — all instances are placed on different hypervisors. soft-affinity — instances are placed on the same hypervisor if possible, but not enforced. soft-anti-affinity — instances are placed on different hypervisors if possible, but not enforced.
display_name string
instances array of objects
instances.backend_id string Instance ID in the OpenStack backend
instances.name string
instances.uuid string (uuid)
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Get server group details

Retrieve details of a specific server group.

1
2
3
4
http \
  GET \
  https://api.example.com/api/openstack-server-groups/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.open_stack_server_group_field_enum import OpenStackServerGroupFieldEnum # (1)
from waldur_api_client.api.openstack_server_groups import openstack_server_groups_retrieve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_server_groups_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. Model Source: OpenStackServerGroupFieldEnum
  2. API Source: openstack_server_groups_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackServerGroupsRetrieve } from 'waldur-js-client';

try {
  const response = await openstackServerGroupsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type
field array

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
tenant string (uri)
tenant_name string
tenant_uuid string (uuid)
policy any affinity — all instances are placed on the same hypervisor. anti-affinity — all instances are placed on different hypervisors. soft-affinity — instances are placed on the same hypervisor if possible, but not enforced. soft-anti-affinity — instances are placed on different hypervisors if possible, but not enforced.
display_name string
instances array of objects
instances.backend_id string Instance ID in the OpenStack backend
instances.name string
instances.uuid string (uuid)
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Create

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/openstack-server-groups/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-openstack-server-group"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.open_stack_server_group_request import OpenStackServerGroupRequest # (1)
from waldur_api_client.api.openstack_server_groups import openstack_server_groups_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OpenStackServerGroupRequest(
    name="my-awesome-openstack-server-group"
)
response = openstack_server_groups_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OpenStackServerGroupRequest
  2. API Source: openstack_server_groups_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackServerGroupsCreate } from 'waldur-js-client';

try {
  const response = await openstackServerGroupsCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "name": "my-awesome-openstack-server-group"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
name string ✓
description string
policy any affinity — all instances are placed on the same hypervisor. anti-affinity — all instances are placed on different hypervisors. soft-affinity — instances are placed on the same hypervisor if possible, but not enforced. soft-anti-affinity — instances are placed on different hypervisors if possible, but not enforced.

201 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
tenant string (uri)
tenant_name string
tenant_uuid string (uuid)
policy any affinity — all instances are placed on the same hypervisor. anti-affinity — all instances are placed on different hypervisors. soft-affinity — instances are placed on the same hypervisor if possible, but not enforced. soft-anti-affinity — instances are placed on different hypervisors if possible, but not enforced.
display_name string
instances array of objects
instances.backend_id string Instance ID in the OpenStack backend
instances.name string
instances.uuid string (uuid)
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Synchronize resource state

Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.

1
2
3
4
http \
  POST \
  https://api.example.com/api/openstack-server-groups/a1b2c3d4-e5f6-7890-abcd-ef1234567890/pull/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_server_groups import openstack_server_groups_pull # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_server_groups_pull.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openstack_server_groups_pull
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackServerGroupsPull } from 'waldur-js-client';

try {
  const response = await openstackServerGroupsPull({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

202 -

Field Type
detail string

409 -

Field Type
detail string

Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state.

1
2
3
4
http \
  POST \
  https://api.example.com/api/openstack-server-groups/a1b2c3d4-e5f6-7890-abcd-ef1234567890/unlink/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_server_groups import openstack_server_groups_unlink # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_server_groups_unlink.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openstack_server_groups_unlink
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackServerGroupsUnlink } from 'waldur-js-client';

try {
  const response = await openstackServerGroupsUnlink({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Delete server group

Delete a server group.

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/openstack-server-groups/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_server_groups import openstack_server_groups_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_server_groups_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openstack_server_groups_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackServerGroupsDestroy } from 'waldur-js-client';

try {
  const response = await openstackServerGroupsDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Other Actions

Mark resource as ERRED

Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.

1
2
3
4
http \
  POST \
  https://api.example.com/api/openstack-server-groups/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_erred/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.set_erred_request import SetErredRequest # (1)
from waldur_api_client.api.openstack_server_groups import openstack_server_groups_set_erred # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = SetErredRequest()
response = openstack_server_groups_set_erred.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: SetErredRequest
  2. API Source: openstack_server_groups_set_erred
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackServerGroupsSetErred } from 'waldur-js-client';

try {
  const response = await openstackServerGroupsSetErred({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
error_message string
error_traceback string

200 -

Field Type
detail string

Mark resource as OK

Manually transition the resource to OK state and clear error fields. Staff-only operation.

1
2
3
4
http \
  POST \
  https://api.example.com/api/openstack-server-groups/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_ok/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_server_groups import openstack_server_groups_set_ok # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_server_groups_set_ok.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openstack_server_groups_set_ok
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackServerGroupsSetOk } from 'waldur-js-client';

try {
  const response = await openstackServerGroupsSetOk({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
detail string

Openstack Snapshots

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/openstack-snapshots/ List snapshots
GET /api/openstack-snapshots/{uuid}/ Get snapshot details
POST /api/openstack-snapshots/{uuid}/pull/ Synchronize resource state
POST /api/openstack-snapshots/{uuid}/unlink/ Unlink resource
PUT /api/openstack-snapshots/{uuid}/ Update snapshot
PATCH /api/openstack-snapshots/{uuid}/ Partially update snapshot
DELETE /api/openstack-snapshots/{uuid}/ Delete snapshot
Other Actions
GET /api/openstack-snapshots/{uuid}/restorations/ List snapshot restorations
POST /api/openstack-snapshots/{uuid}/restore/ Restore volume from snapshot
POST /api/openstack-snapshots/{uuid}/set_erred/ Mark resource as ERRED
POST /api/openstack-snapshots/{uuid}/set_ok/ Mark resource as OK

Core CRUD

List snapshots

Get a list of snapshots.

1
2
3
4
http \
  GET \
  https://api.example.com/api/openstack-snapshots/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.core_states import CoreStates # (1)
from waldur_api_client.models.open_stack_snapshot_field_enum import OpenStackSnapshotFieldEnum # (2)
from waldur_api_client.api.openstack_snapshots import openstack_snapshots_list # (3)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_snapshots_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: CoreStates
  2. Model Source: OpenStackSnapshotFieldEnum
  3. API Source: openstack_snapshots_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { openstackSnapshotsList } from 'waldur-js-client';

try {
  const response = await openstackSnapshotsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
backend_id string Backend ID
backup string (uri) Backup URL
backup_uuid string (uuid) Backup UUID
can_manage boolean Can manage
customer string (uuid) Customer UUID
customer_abbreviation string Customer abbreviation
customer_name string Customer name
customer_native_name string Customer native name
customer_uuid string (uuid) Customer UUID
description string Description
external_ip string External IP
field array
name string Name
name_exact string Name (exact)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
project string (uuid) Project UUID
project_name string Project name
project_uuid string (uuid) Project UUID
runtime_state string
service_settings_name string Service settings name
service_settings_uuid string (uuid) Service settings UUID
source_volume string (uri) Source volume URL
source_volume_uuid string (uuid) Source volume UUID
state array State
tenant string (uri) Tenant URL
tenant_uuid string (uuid) Tenant UUID
uuid string (uuid) UUID

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string Snapshot ID in the OpenStack backend
access_url string
source_volume string (uri) Volume from which this snapshot was created
size integer Size in MiB
metadata any
runtime_state string
source_volume_name string
source_volume_marketplace_uuid string (uuid)
action string
action_details any
restorations array of objects
restorations.uuid string (uuid)
restorations.created string (date-time)
restorations.description string New volume description.
restorations.volume string (uri) Volume that is being restored from the snapshot
restorations.volume_name string
restorations.volume_state string
restorations.volume_runtime_state string
restorations.volume_size integer Size in MiB
restorations.volume_device string Name of volume as instance device e.g. /dev/vdb.
kept_until string (date-time) Guaranteed time of snapshot retention. If null - keep forever.
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Get snapshot details

Retrieve details of a specific snapshot.

1
2
3
4
http \
  GET \
  https://api.example.com/api/openstack-snapshots/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.open_stack_snapshot_field_enum import OpenStackSnapshotFieldEnum # (1)
from waldur_api_client.api.openstack_snapshots import openstack_snapshots_retrieve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_snapshots_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. Model Source: OpenStackSnapshotFieldEnum
  2. API Source: openstack_snapshots_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackSnapshotsRetrieve } from 'waldur-js-client';

try {
  const response = await openstackSnapshotsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type
field array

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string Snapshot ID in the OpenStack backend
access_url string
source_volume string (uri) Volume from which this snapshot was created
size integer Size in MiB
metadata any
runtime_state string
source_volume_name string
source_volume_marketplace_uuid string (uuid)
action string
action_details any
restorations array of objects
restorations.uuid string (uuid)
restorations.created string (date-time)
restorations.description string New volume description.
restorations.volume string (uri) Volume that is being restored from the snapshot
restorations.volume_name string
restorations.volume_state string
restorations.volume_runtime_state string
restorations.volume_size integer Size in MiB
restorations.volume_device string Name of volume as instance device e.g. /dev/vdb.
kept_until string (date-time) Guaranteed time of snapshot retention. If null - keep forever.
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Synchronize resource state

Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.

1
2
3
4
http \
  POST \
  https://api.example.com/api/openstack-snapshots/a1b2c3d4-e5f6-7890-abcd-ef1234567890/pull/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_snapshots import openstack_snapshots_pull # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_snapshots_pull.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openstack_snapshots_pull
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackSnapshotsPull } from 'waldur-js-client';

try {
  const response = await openstackSnapshotsPull({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

202 -

Field Type
detail string

409 -

Field Type
detail string

Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state.

1
2
3
4
http \
  POST \
  https://api.example.com/api/openstack-snapshots/a1b2c3d4-e5f6-7890-abcd-ef1234567890/unlink/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_snapshots import openstack_snapshots_unlink # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_snapshots_unlink.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openstack_snapshots_unlink
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackSnapshotsUnlink } from 'waldur-js-client';

try {
  const response = await openstackSnapshotsUnlink({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Update snapshot

Update an existing snapshot.

1
2
3
4
5
http \
  PUT \
  https://api.example.com/api/openstack-snapshots/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-openstack-snapshot"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.open_stack_snapshot_request import OpenStackSnapshotRequest # (1)
from waldur_api_client.api.openstack_snapshots import openstack_snapshots_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OpenStackSnapshotRequest(
    name="my-awesome-openstack-snapshot"
)
response = openstack_snapshots_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OpenStackSnapshotRequest
  2. API Source: openstack_snapshots_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { openstackSnapshotsUpdate } from 'waldur-js-client';

try {
  const response = await openstackSnapshotsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-openstack-snapshot"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
name string ✓
description string
metadata any
kept_until string (date-time) Guaranteed time of snapshot retention. If null - keep forever.

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string Snapshot ID in the OpenStack backend
access_url string
source_volume string (uri) Volume from which this snapshot was created
size integer Size in MiB
metadata any
runtime_state string
source_volume_name string
source_volume_marketplace_uuid string (uuid)
action string
action_details any
restorations array of objects
restorations.uuid string (uuid)
restorations.created string (date-time)
restorations.description string New volume description.
restorations.volume string (uri) Volume that is being restored from the snapshot
restorations.volume_name string
restorations.volume_state string
restorations.volume_runtime_state string
restorations.volume_size integer Size in MiB
restorations.volume_device string Name of volume as instance device e.g. /dev/vdb.
kept_until string (date-time) Guaranteed time of snapshot retention. If null - keep forever.
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Partially update snapshot

Update specific fields of a snapshot.

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/openstack-snapshots/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_open_stack_snapshot_request import PatchedOpenStackSnapshotRequest # (1)
from waldur_api_client.api.openstack_snapshots import openstack_snapshots_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedOpenStackSnapshotRequest()
response = openstack_snapshots_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedOpenStackSnapshotRequest
  2. API Source: openstack_snapshots_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackSnapshotsPartialUpdate } from 'waldur-js-client';

try {
  const response = await openstackSnapshotsPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
name string
description string
metadata any
kept_until string (date-time) Guaranteed time of snapshot retention. If null - keep forever.

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string Snapshot ID in the OpenStack backend
access_url string
source_volume string (uri) Volume from which this snapshot was created
size integer Size in MiB
metadata any
runtime_state string
source_volume_name string
source_volume_marketplace_uuid string (uuid)
action string
action_details any
restorations array of objects
restorations.uuid string (uuid)
restorations.created string (date-time)
restorations.description string New volume description.
restorations.volume string (uri) Volume that is being restored from the snapshot
restorations.volume_name string
restorations.volume_state string
restorations.volume_runtime_state string
restorations.volume_size integer Size in MiB
restorations.volume_device string Name of volume as instance device e.g. /dev/vdb.
kept_until string (date-time) Guaranteed time of snapshot retention. If null - keep forever.
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Delete snapshot

Delete a snapshot.

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/openstack-snapshots/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_snapshots import openstack_snapshots_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_snapshots_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openstack_snapshots_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackSnapshotsDestroy } from 'waldur-js-client';

try {
  const response = await openstackSnapshotsDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Other Actions

List snapshot restorations

Get a list of snapshot restorations

1
2
3
4
http \
  GET \
  https://api.example.com/api/openstack-snapshots/a1b2c3d4-e5f6-7890-abcd-ef1234567890/restorations/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_snapshots import openstack_snapshots_restorations_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_snapshots_restorations_list.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

for item in response:
    print(item)
  1. API Source: openstack_snapshots_restorations_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackSnapshotsRestorationsList } from 'waldur-js-client';

try {
  const response = await openstackSnapshotsRestorationsList({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid)
created string (date-time)
description string New volume description.
volume string (uri) Volume that is being restored from the snapshot
volume_name string
volume_state string
volume_runtime_state string
volume_size integer Size in MiB
volume_device string Name of volume as instance device e.g. /dev/vdb.

Restore volume from snapshot

Restore volume from snapshot

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/openstack-snapshots/a1b2c3d4-e5f6-7890-abcd-ef1234567890/restore/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-openstack-snapshot"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.open_stack_snapshot_restoration_request import OpenStackSnapshotRestorationRequest # (1)
from waldur_api_client.api.openstack_snapshots import openstack_snapshots_restore # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OpenStackSnapshotRestorationRequest(
    name="my-awesome-openstack-snapshot"
)
response = openstack_snapshots_restore.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OpenStackSnapshotRestorationRequest
  2. API Source: openstack_snapshots_restore
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { openstackSnapshotsRestore } from 'waldur-js-client';

try {
  const response = await openstackSnapshotsRestore({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-openstack-snapshot"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
name string ✓ New volume name.
Constraints: write-only
description string New volume description.

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string Volume ID in the OpenStack backend
access_url string
source_snapshot string (uri) Snapshot that this volume was created from, if any
size integer Size in MiB
bootable boolean Indicates if this volume can be used to boot an instance
metadata any
image string (uri) Image that this volume was created from, if any
image_metadata string Metadata of the image this volume was created from
image_name string Name of the image this volume was created from
type string (uri) Type of the volume (e.g. SSD, HDD)
type_name string
runtime_state string
availability_zone string (uri) Availability zone where this volume is located
availability_zone_name string
device string Name of volume as instance device e.g. /dev/vdb.
action string
action_details any
instance string (uri) Instance that this volume is attached to, if any
instance_name string
instance_marketplace_uuid string (uuid)
tenant string (uri)
tenant_uuid string (uuid)
extend_enabled boolean
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Mark resource as ERRED

Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.

1
2
3
4
http \
  POST \
  https://api.example.com/api/openstack-snapshots/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_erred/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.set_erred_request import SetErredRequest # (1)
from waldur_api_client.api.openstack_snapshots import openstack_snapshots_set_erred # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = SetErredRequest()
response = openstack_snapshots_set_erred.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: SetErredRequest
  2. API Source: openstack_snapshots_set_erred
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackSnapshotsSetErred } from 'waldur-js-client';

try {
  const response = await openstackSnapshotsSetErred({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
error_message string
error_traceback string

200 -

Field Type
detail string

Mark resource as OK

Manually transition the resource to OK state and clear error fields. Staff-only operation.

1
2
3
4
http \
  POST \
  https://api.example.com/api/openstack-snapshots/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_ok/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_snapshots import openstack_snapshots_set_ok # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_snapshots_set_ok.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openstack_snapshots_set_ok
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackSnapshotsSetOk } from 'waldur-js-client';

try {
  const response = await openstackSnapshotsSetOk({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
detail string

Openstack Subnets

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/openstack-subnets/ List subnets
GET /api/openstack-subnets/{uuid}/ Get subnet details
POST /api/openstack-subnets/{uuid}/pull/ Synchronize resource state
POST /api/openstack-subnets/{uuid}/unlink/ Unlink resource
PUT /api/openstack-subnets/{uuid}/ Update subnet
PATCH /api/openstack-subnets/{uuid}/ Partially update subnet
DELETE /api/openstack-subnets/{uuid}/ Delete subnet
Other Actions
POST /api/openstack-subnets/{uuid}/connect/ Connect subnet to router
POST /api/openstack-subnets/{uuid}/disconnect/ Disconnect subnet from router
POST /api/openstack-subnets/{uuid}/set_erred/ Mark resource as ERRED
POST /api/openstack-subnets/{uuid}/set_ok/ Mark resource as OK

Core CRUD

List subnets

Get a list of subnets.

1
2
3
4
http \
  GET \
  https://api.example.com/api/openstack-subnets/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.core_states import CoreStates # (1)
from waldur_api_client.models.open_stack_sub_net_field_enum import OpenStackSubNetFieldEnum # (2)
from waldur_api_client.api.openstack_subnets import openstack_subnets_list # (3)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_subnets_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: CoreStates
  2. Model Source: OpenStackSubNetFieldEnum
  3. API Source: openstack_subnets_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { openstackSubnetsList } from 'waldur-js-client';

try {
  const response = await openstackSubnetsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
backend_id string Backend ID
can_manage boolean Can manage
customer string (uuid) Customer UUID
customer_abbreviation string Customer abbreviation
customer_name string Customer name
customer_native_name string Customer native name
customer_uuid string (uuid) Customer UUID
description string Description
direct_only boolean Direct only
enable_dhcp boolean
external_ip string External IP
field array
ip_version integer
name string Name
name_exact string Name (exact)
network string (uri) Network URL
network_uuid string (uuid) Network UUID
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
project string (uuid) Project UUID
project_name string Project name
project_uuid string (uuid) Project UUID
rbac_only boolean RBAC only
service_settings_name string Service settings name
service_settings_uuid string (uuid) Service settings UUID
state array State
tenant string (uri) Tenant URL
tenant_uuid string (uuid) Tenant UUID
uuid string (uuid) UUID

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
tenant string (uri)
tenant_name string
network string (uri) Network to which this subnet belongs
network_name string
cidr string
gateway_ip any IP address of the gateway for this subnet
disable_gateway boolean If True, no gateway IP address will be allocated
allocation_pools array of objects
allocation_pools.start any An IPv4 or IPv6 address.
allocation_pools.end any An IPv4 or IPv6 address.
ip_version integer IP protocol version (4 or 6)
enable_dhcp boolean If True, DHCP service will be enabled on this subnet
dns_nameservers array of anys
host_routes array of objects
host_routes.destination string
host_routes.nexthop any An IPv4 or IPv6 address.
is_connected boolean Is subnet connected to the default tenant router.
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Get subnet details

Retrieve details of a specific subnet.

1
2
3
4
http \
  GET \
  https://api.example.com/api/openstack-subnets/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.open_stack_sub_net_field_enum import OpenStackSubNetFieldEnum # (1)
from waldur_api_client.api.openstack_subnets import openstack_subnets_retrieve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_subnets_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. Model Source: OpenStackSubNetFieldEnum
  2. API Source: openstack_subnets_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackSubnetsRetrieve } from 'waldur-js-client';

try {
  const response = await openstackSubnetsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type
field array

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
tenant string (uri)
tenant_name string
network string (uri) Network to which this subnet belongs
network_name string
cidr string
gateway_ip any IP address of the gateway for this subnet
disable_gateway boolean If True, no gateway IP address will be allocated
allocation_pools array of objects
allocation_pools.start any An IPv4 or IPv6 address.
allocation_pools.end any An IPv4 or IPv6 address.
ip_version integer IP protocol version (4 or 6)
enable_dhcp boolean If True, DHCP service will be enabled on this subnet
dns_nameservers array of anys
host_routes array of objects
host_routes.destination string
host_routes.nexthop any An IPv4 or IPv6 address.
is_connected boolean Is subnet connected to the default tenant router.
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Synchronize resource state

Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.

1
2
3
4
http \
  POST \
  https://api.example.com/api/openstack-subnets/a1b2c3d4-e5f6-7890-abcd-ef1234567890/pull/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_subnets import openstack_subnets_pull # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_subnets_pull.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openstack_subnets_pull
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackSubnetsPull } from 'waldur-js-client';

try {
  const response = await openstackSubnetsPull({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

202 -

Field Type
detail string

409 -

Field Type
detail string

Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state.

1
2
3
4
http \
  POST \
  https://api.example.com/api/openstack-subnets/a1b2c3d4-e5f6-7890-abcd-ef1234567890/unlink/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_subnets import openstack_subnets_unlink # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_subnets_unlink.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openstack_subnets_unlink
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackSubnetsUnlink } from 'waldur-js-client';

try {
  const response = await openstackSubnetsUnlink({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Update subnet

Update an existing subnet.

1
2
3
4
5
http \
  PUT \
  https://api.example.com/api/openstack-subnets/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-openstack-subnet"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.open_stack_sub_net_request import OpenStackSubNetRequest # (1)
from waldur_api_client.api.openstack_subnets import openstack_subnets_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OpenStackSubNetRequest(
    name="my-awesome-openstack-subnet"
)
response = openstack_subnets_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OpenStackSubNetRequest
  2. API Source: openstack_subnets_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { openstackSubnetsUpdate } from 'waldur-js-client';

try {
  const response = await openstackSubnetsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-openstack-subnet"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
name string ✓
description string
cidr string
gateway_ip any IP address of the gateway for this subnet
disable_gateway boolean If True, no gateway IP address will be allocated
allocation_pools array of objects
allocation_pools.start any ✓ An IPv4 or IPv6 address.
allocation_pools.end any ✓ An IPv4 or IPv6 address.
dns_nameservers array of anys
host_routes array of objects
host_routes.destination string ✓
host_routes.nexthop any ✓ An IPv4 or IPv6 address.

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
tenant string (uri)
tenant_name string
network string (uri) Network to which this subnet belongs
network_name string
cidr string
gateway_ip any IP address of the gateway for this subnet
disable_gateway boolean If True, no gateway IP address will be allocated
allocation_pools array of objects
allocation_pools.start any An IPv4 or IPv6 address.
allocation_pools.end any An IPv4 or IPv6 address.
ip_version integer IP protocol version (4 or 6)
enable_dhcp boolean If True, DHCP service will be enabled on this subnet
dns_nameservers array of anys
host_routes array of objects
host_routes.destination string
host_routes.nexthop any An IPv4 or IPv6 address.
is_connected boolean Is subnet connected to the default tenant router.
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Partially update subnet

Update specific fields of a subnet.

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/openstack-subnets/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_open_stack_sub_net_request import PatchedOpenStackSubNetRequest # (1)
from waldur_api_client.api.openstack_subnets import openstack_subnets_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedOpenStackSubNetRequest()
response = openstack_subnets_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedOpenStackSubNetRequest
  2. API Source: openstack_subnets_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackSubnetsPartialUpdate } from 'waldur-js-client';

try {
  const response = await openstackSubnetsPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
name string
description string
cidr string
gateway_ip any IP address of the gateway for this subnet
disable_gateway boolean If True, no gateway IP address will be allocated
allocation_pools array of objects
allocation_pools.start any ✓ An IPv4 or IPv6 address.
allocation_pools.end any ✓ An IPv4 or IPv6 address.
dns_nameservers array of anys
host_routes array of objects
host_routes.destination string ✓
host_routes.nexthop any ✓ An IPv4 or IPv6 address.

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
tenant string (uri)
tenant_name string
network string (uri) Network to which this subnet belongs
network_name string
cidr string
gateway_ip any IP address of the gateway for this subnet
disable_gateway boolean If True, no gateway IP address will be allocated
allocation_pools array of objects
allocation_pools.start any An IPv4 or IPv6 address.
allocation_pools.end any An IPv4 or IPv6 address.
ip_version integer IP protocol version (4 or 6)
enable_dhcp boolean If True, DHCP service will be enabled on this subnet
dns_nameservers array of anys
host_routes array of objects
host_routes.destination string
host_routes.nexthop any An IPv4 or IPv6 address.
is_connected boolean Is subnet connected to the default tenant router.
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Delete subnet

Delete a subnet.

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/openstack-subnets/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_subnets import openstack_subnets_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_subnets_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openstack_subnets_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackSubnetsDestroy } from 'waldur-js-client';

try {
  const response = await openstackSubnetsDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Other Actions

Connect subnet to router

Connect the subnet to the default tenant router.

1
2
3
4
http \
  POST \
  https://api.example.com/api/openstack-subnets/a1b2c3d4-e5f6-7890-abcd-ef1234567890/connect/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_subnets import openstack_subnets_connect # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_subnets_connect.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openstack_subnets_connect
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackSubnetsConnect } from 'waldur-js-client';

try {
  const response = await openstackSubnetsConnect({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 - No response body

Disconnect subnet from router

Disconnect the subnet from the default tenant router.

1
2
3
4
http \
  POST \
  https://api.example.com/api/openstack-subnets/a1b2c3d4-e5f6-7890-abcd-ef1234567890/disconnect/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_subnets import openstack_subnets_disconnect # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_subnets_disconnect.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openstack_subnets_disconnect
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackSubnetsDisconnect } from 'waldur-js-client';

try {
  const response = await openstackSubnetsDisconnect({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 - No response body

Mark resource as ERRED

Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.

1
2
3
4
http \
  POST \
  https://api.example.com/api/openstack-subnets/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_erred/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.set_erred_request import SetErredRequest # (1)
from waldur_api_client.api.openstack_subnets import openstack_subnets_set_erred # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = SetErredRequest()
response = openstack_subnets_set_erred.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: SetErredRequest
  2. API Source: openstack_subnets_set_erred
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackSubnetsSetErred } from 'waldur-js-client';

try {
  const response = await openstackSubnetsSetErred({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
error_message string
error_traceback string

200 -

Field Type
detail string

Mark resource as OK

Manually transition the resource to OK state and clear error fields. Staff-only operation.

1
2
3
4
http \
  POST \
  https://api.example.com/api/openstack-subnets/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_ok/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_subnets import openstack_subnets_set_ok # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_subnets_set_ok.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openstack_subnets_set_ok
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackSubnetsSetOk } from 'waldur-js-client';

try {
  const response = await openstackSubnetsSetOk({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
detail string

Openstack Tenants

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/openstack-tenants/ List tenants
GET /api/openstack-tenants/{uuid}/ Get tenant details
POST /api/openstack-tenants/{uuid}/pull/ Synchronize resource state
POST /api/openstack-tenants/{uuid}/unlink/ Unlink resource
PUT /api/openstack-tenants/{uuid}/ Update tenant
PATCH /api/openstack-tenants/{uuid}/ Partially update tenant
Configuration & Updates
POST /api/openstack-tenants/{uuid}/change_password/ Change tenant user password
POST /api/openstack-tenants/{uuid}/set_quotas/ Set tenant quotas
Sub-Resource Creation
POST /api/openstack-tenants/{uuid}/create_floating_ip/ Create floating IP for tenant
POST /api/openstack-tenants/{uuid}/create_network/ Create network for tenant
POST /api/openstack-tenants/{uuid}/create_security_group/ Create security group
POST /api/openstack-tenants/{uuid}/create_server_group/ Create server group
Data & Reporting
GET /api/openstack-tenants/{uuid}/backend_instances/ List backend instances
GET /api/openstack-tenants/{uuid}/backend_volumes/ List backend volumes
Remote Actions & Sync
POST /api/openstack-tenants/{uuid}/pull_floating_ips/ Pull floating IPs
POST /api/openstack-tenants/{uuid}/pull_quotas/ Pull tenant quotas
POST /api/openstack-tenants/{uuid}/pull_security_groups/ Pull security groups
POST /api/openstack-tenants/{uuid}/pull_server_groups/ Pull server groups
Other Actions
POST /api/openstack-tenants/{uuid}/push_security_groups/ Batch update security groups for a tenant.
POST /api/openstack-tenants/{uuid}/set_erred/ Mark resource as ERRED
POST /api/openstack-tenants/{uuid}/set_ok/ Mark resource as OK

Core CRUD

List tenants

Get a list of OpenStack tenants.

1
2
3
4
http \
  GET \
  https://api.example.com/api/openstack-tenants/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.core_states import CoreStates # (1)
from waldur_api_client.models.open_stack_tenant_field_enum import OpenStackTenantFieldEnum # (2)
from waldur_api_client.api.openstack_tenants import openstack_tenants_list # (3)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_tenants_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: CoreStates
  2. Model Source: OpenStackTenantFieldEnum
  3. API Source: openstack_tenants_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { openstackTenantsList } from 'waldur-js-client';

try {
  const response = await openstackTenantsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
backend_id string Backend ID
can_manage boolean Can manage
customer string (uuid) Customer UUID
customer_abbreviation string Customer abbreviation
customer_name string Customer name
customer_native_name string Customer native name
customer_uuid string (uuid) Customer UUID
description string Description
external_ip string External IP
field array
name string Name
name_exact string Name (exact)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
project string (uuid) Project UUID
project_name string Project name
project_uuid string (uuid) Project UUID
service_settings_name string Service settings name
service_settings_uuid string (uuid) Service settings UUID
state array State
uuid string (uuid) UUID

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string ID of tenant in the OpenStack backend
access_url string
availability_zone string Optional availability group. Will be used for all instances provisioned in this tenant
internal_network_id string ID of internal network in OpenStack tenant
external_network_id string ID of external network connected to OpenStack tenant
external_network_ref_uuid string (uuid)
external_network_ref_name string
user_username string Username of the tenant user
user_password string Password of the tenant user
quotas array of objects
quotas.name string
quotas.usage integer
quotas.limit integer
default_volume_type_name string Volume type name to use when creating volumes.
skip_creation_of_default_router boolean
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Get tenant details

Retrieve details of a specific OpenStack tenant.

1
2
3
4
http \
  GET \
  https://api.example.com/api/openstack-tenants/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.open_stack_tenant_field_enum import OpenStackTenantFieldEnum # (1)
from waldur_api_client.api.openstack_tenants import openstack_tenants_retrieve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_tenants_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. Model Source: OpenStackTenantFieldEnum
  2. API Source: openstack_tenants_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackTenantsRetrieve } from 'waldur-js-client';

try {
  const response = await openstackTenantsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type
field array

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string ID of tenant in the OpenStack backend
access_url string
availability_zone string Optional availability group. Will be used for all instances provisioned in this tenant
internal_network_id string ID of internal network in OpenStack tenant
external_network_id string ID of external network connected to OpenStack tenant
external_network_ref_uuid string (uuid)
external_network_ref_name string
user_username string Username of the tenant user
user_password string Password of the tenant user
quotas array of objects
quotas.name string
quotas.usage integer
quotas.limit integer
default_volume_type_name string Volume type name to use when creating volumes.
skip_creation_of_default_router boolean
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Synchronize resource state

Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.

1
2
3
4
http \
  POST \
  https://api.example.com/api/openstack-tenants/a1b2c3d4-e5f6-7890-abcd-ef1234567890/pull/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_tenants import openstack_tenants_pull # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_tenants_pull.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openstack_tenants_pull
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackTenantsPull } from 'waldur-js-client';

try {
  const response = await openstackTenantsPull({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

202 -

Field Type
detail string

409 -

Field Type
detail string

Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state.

1
2
3
4
http \
  POST \
  https://api.example.com/api/openstack-tenants/a1b2c3d4-e5f6-7890-abcd-ef1234567890/unlink/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_tenants import openstack_tenants_unlink # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_tenants_unlink.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openstack_tenants_unlink
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackTenantsUnlink } from 'waldur-js-client';

try {
  const response = await openstackTenantsUnlink({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Update tenant

Update an existing OpenStack tenant.

1
2
3
4
5
http \
  PUT \
  https://api.example.com/api/openstack-tenants/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-openstack-tenant"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.open_stack_tenant_request import OpenStackTenantRequest # (1)
from waldur_api_client.api.openstack_tenants import openstack_tenants_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OpenStackTenantRequest(
    name="my-awesome-openstack-tenant"
)
response = openstack_tenants_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OpenStackTenantRequest
  2. API Source: openstack_tenants_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { openstackTenantsUpdate } from 'waldur-js-client';

try {
  const response = await openstackTenantsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-openstack-tenant"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
name string ✓
description string
availability_zone string Optional availability group. Will be used for all instances provisioned in this tenant
default_volume_type_name string Volume type name to use when creating volumes.
security_groups array of objects
Constraints: write-only
security_groups.name string ✓
security_groups.description string
security_groups.rules array of objects
security_groups.rules.ethertype any IP protocol version - either 'IPv4' or 'IPv6'
security_groups.rules.direction any Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing)
security_groups.rules.protocol any The network protocol (TCP, UDP, ICMP, or empty for any protocol)
security_groups.rules.from_port integer Starting port number in the range (1-65535)
security_groups.rules.to_port integer Ending port number in the range (1-65535)
security_groups.rules.cidr string CIDR notation for the source/destination network address range
security_groups.rules.description string
security_groups.rules.remote_group string (uri) Remote security group that this rule references, if any
skip_creation_of_default_subnet boolean
Constraints: write-only, default: False
skip_creation_of_default_router boolean
Constraints: default: False

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string ID of tenant in the OpenStack backend
access_url string
availability_zone string Optional availability group. Will be used for all instances provisioned in this tenant
internal_network_id string ID of internal network in OpenStack tenant
external_network_id string ID of external network connected to OpenStack tenant
external_network_ref_uuid string (uuid)
external_network_ref_name string
user_username string Username of the tenant user
user_password string Password of the tenant user
quotas array of objects
quotas.name string
quotas.usage integer
quotas.limit integer
default_volume_type_name string Volume type name to use when creating volumes.
skip_creation_of_default_router boolean
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Partially update tenant

Update specific fields of an OpenStack tenant.

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/openstack-tenants/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_open_stack_tenant_request import PatchedOpenStackTenantRequest # (1)
from waldur_api_client.api.openstack_tenants import openstack_tenants_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedOpenStackTenantRequest()
response = openstack_tenants_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedOpenStackTenantRequest
  2. API Source: openstack_tenants_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackTenantsPartialUpdate } from 'waldur-js-client';

try {
  const response = await openstackTenantsPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
name string
description string
availability_zone string Optional availability group. Will be used for all instances provisioned in this tenant
default_volume_type_name string Volume type name to use when creating volumes.
security_groups array of objects
Constraints: write-only
security_groups.name string ✓
security_groups.description string
security_groups.rules array of objects
security_groups.rules.ethertype any IP protocol version - either 'IPv4' or 'IPv6'
security_groups.rules.direction any Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing)
security_groups.rules.protocol any The network protocol (TCP, UDP, ICMP, or empty for any protocol)
security_groups.rules.from_port integer Starting port number in the range (1-65535)
security_groups.rules.to_port integer Ending port number in the range (1-65535)
security_groups.rules.cidr string CIDR notation for the source/destination network address range
security_groups.rules.description string
security_groups.rules.remote_group string (uri) Remote security group that this rule references, if any
skip_creation_of_default_subnet boolean
Constraints: write-only, default: False
skip_creation_of_default_router boolean
Constraints: default: False

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string ID of tenant in the OpenStack backend
access_url string
availability_zone string Optional availability group. Will be used for all instances provisioned in this tenant
internal_network_id string ID of internal network in OpenStack tenant
external_network_id string ID of external network connected to OpenStack tenant
external_network_ref_uuid string (uuid)
external_network_ref_name string
user_username string Username of the tenant user
user_password string Password of the tenant user
quotas array of objects
quotas.name string
quotas.usage integer
quotas.limit integer
default_volume_type_name string Volume type name to use when creating volumes.
skip_creation_of_default_router boolean
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Configuration & Updates

Change tenant user password

Change password for tenant user

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/openstack-tenants/a1b2c3d4-e5f6-7890-abcd-ef1234567890/change_password/ \
  Authorization:"Token YOUR_API_TOKEN" \
  user_password="********"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.open_stack_tenant_change_password_request import OpenStackTenantChangePasswordRequest # (1)
from waldur_api_client.api.openstack_tenants import openstack_tenants_change_password # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OpenStackTenantChangePasswordRequest(
    user_password="********"
)
response = openstack_tenants_change_password.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OpenStackTenantChangePasswordRequest
  2. API Source: openstack_tenants_change_password
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { openstackTenantsChangePassword } from 'waldur-js-client';

try {
  const response = await openstackTenantsChangePassword({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "user_password": "********"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
user_password string ✓ New tenant user password.

200 - No response body

Set tenant quotas

A quota can be set for a particular tenant. Only staff users and service provider owners/managers can do that. In order to set quota submit POST request to /api/openstack-tenants//set_quotas/. The quota values are propagated to the backend.

The following quotas are supported. All values are expected to be integers:

  • instances - maximal number of created instances.
  • ram - maximal size of ram for allocation. In MiB_.
  • storage - maximal size of storage for allocation. In MiB_.
  • vcpu - maximal number of virtual cores for allocation.
  • security_group_count - maximal number of created security groups.
  • security_group_rule_count - maximal number of created security groups rules.
  • volumes - maximal number of created volumes.
  • snapshots - maximal number of created snapshots.

It is possible to update quotas by one or by submitting all the fields in one request. Waldur will attempt to update the provided quotas. Please note, that if provided quotas are conflicting with the backend (e.g. requested number of instances is below of the already existing ones), some quotas might not be applied.

.. _MiB: http://en.wikipedia.org/wiki/Mebibyte

Response code of a successful request is 202 ACCEPTED. In case tenant is in a non-stable status, the response would be 409 CONFLICT. In this case REST client is advised to repeat the request after some time. On successful completion the task will synchronize quotas with the backend.

1
2
3
4
http \
  POST \
  https://api.example.com/api/openstack-tenants/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_quotas/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.open_stack_tenant_quota_request import OpenStackTenantQuotaRequest # (1)
from waldur_api_client.api.openstack_tenants import openstack_tenants_set_quotas # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OpenStackTenantQuotaRequest()
response = openstack_tenants_set_quotas.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OpenStackTenantQuotaRequest
  2. API Source: openstack_tenants_set_quotas
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackTenantsSetQuotas } from 'waldur-js-client';

try {
  const response = await openstackTenantsSetQuotas({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
instances integer
volumes integer
snapshots integer
ram integer
vcpu integer
storage integer
security_group_count integer
security_group_rule_count integer

200 -

Field Type
instances integer
volumes integer
snapshots integer
ram integer
vcpu integer
storage integer
security_group_count integer
security_group_rule_count integer

Sub-Resource Creation

Create floating IP for tenant

Create floating IP for tenant

1
2
3
4
http \
  POST \
  https://api.example.com/api/openstack-tenants/a1b2c3d4-e5f6-7890-abcd-ef1234567890/create_floating_ip/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.open_stack_floating_ip_request import OpenStackFloatingIPRequest # (1)
from waldur_api_client.api.openstack_tenants import openstack_tenants_create_floating_ip # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OpenStackFloatingIPRequest()
response = openstack_tenants_create_floating_ip.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OpenStackFloatingIPRequest
  2. API Source: openstack_tenants_create_floating_ip
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackTenantsCreateFloatingIp } from 'waldur-js-client';

try {
  const response = await openstackTenantsCreateFloatingIp({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
router string (uri) Optional router to use for external network detection
Constraints: write-only

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
runtime_state string
address any The public IPv4 address of the floating IP
backend_network_id string ID of network in OpenStack where this floating IP is allocated
tenant string (uri) OpenStack tenant this floating IP belongs to
tenant_name string
tenant_uuid string (uuid)
port string (uri)
external_address any Optional address that maps to floating IP's address in external networks
port_fixed_ips array of objects
port_fixed_ips.ip_address any IP address to assign to the port
port_fixed_ips.subnet_id string ID of the subnet in which to assign the IP address
instance_uuid string
instance_name string
instance_url string
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Create network for tenant

Create network for tenant

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/openstack-tenants/a1b2c3d4-e5f6-7890-abcd-ef1234567890/create_network/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-openstack-tenant"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.open_stack_network_request import OpenStackNetworkRequest # (1)
from waldur_api_client.api.openstack_tenants import openstack_tenants_create_network # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OpenStackNetworkRequest(
    name="my-awesome-openstack-tenant"
)
response = openstack_tenants_create_network.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OpenStackNetworkRequest
  2. API Source: openstack_tenants_create_network
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { openstackTenantsCreateNetwork } from 'waldur-js-client';

try {
  const response = await openstackTenantsCreateNetwork({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-openstack-tenant"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
name string ✓
description string

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
tenant string (uri) OpenStack tenant this network belongs to
tenant_name string
tenant_uuid string (uuid)
is_external boolean Defines whether this network is external (public) or internal (private)
type string Network type, such as local, flat, vlan, vxlan, or gre
segmentation_id integer VLAN ID for VLAN networks or tunnel ID for VXLAN/GRE networks
subnets array of objects
subnets.uuid string (uuid)
subnets.name string
subnets.description string
subnets.cidr string IPv4 network address in CIDR format (e.g. 192.168.0.0/24)
subnets.gateway_ip any IP address of the gateway for this subnet
subnets.allocation_pools array of objects
subnets.allocation_pools.start any An IPv4 or IPv6 address.
subnets.allocation_pools.end any An IPv4 or IPv6 address.
subnets.ip_version integer IP protocol version (4 or 6)
subnets.enable_dhcp boolean If True, DHCP service will be enabled on this subnet
mtu integer The maximum transmission unit (MTU) value to address fragmentation.
rbac_policies array of objects
rbac_policies.url string (uri)
rbac_policies.uuid string (uuid)
rbac_policies.network string (uri)
rbac_policies.network_name string
rbac_policies.target_tenant string (uri)
rbac_policies.target_tenant_name string
rbac_policies.backend_id string
rbac_policies.policy_type any Type of access granted - either shared access or external network access
rbac_policies.created string (date-time)
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Create security group

Create a security group for the tenant.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/openstack-tenants/a1b2c3d4-e5f6-7890-abcd-ef1234567890/create_security_group/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-openstack-tenant" \
  rules:='[]'

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.open_stack_security_group_request import OpenStackSecurityGroupRequest # (1)
from waldur_api_client.api.openstack_tenants import openstack_tenants_create_security_group # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OpenStackSecurityGroupRequest(
    name="my-awesome-openstack-tenant",
    rules=[]
)
response = openstack_tenants_create_security_group.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OpenStackSecurityGroupRequest
  2. API Source: openstack_tenants_create_security_group
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { openstackTenantsCreateSecurityGroup } from 'waldur-js-client';

try {
  const response = await openstackTenantsCreateSecurityGroup({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-openstack-tenant",
    "rules": []
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
name string ✓
description string
rules array of objects ✓
rules.ethertype any IP protocol version - either 'IPv4' or 'IPv6'
rules.direction any Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing)
rules.protocol any The network protocol (TCP, UDP, ICMP, or empty for any protocol)
rules.from_port integer Starting port number in the range (1-65535)
rules.to_port integer Ending port number in the range (1-65535)
rules.cidr string CIDR notation for the source/destination network address range
rules.description string
rules.remote_group string (uri) Remote security group that this rule references, if any

201 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
tenant string (uri)
tenant_name string
tenant_uuid string (uuid)
rules array of objects
rules.ethertype any IP protocol version - either 'IPv4' or 'IPv6'
rules.direction any Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing)
rules.protocol any The network protocol (TCP, UDP, ICMP, or empty for any protocol)
rules.from_port integer Starting port number in the range (1-65535)
rules.to_port integer Ending port number in the range (1-65535)
rules.cidr string CIDR notation for the source/destination network address range
rules.description string
rules.remote_group_name string
rules.remote_group_uuid string (uuid)
rules.id integer
rules.remote_group string (uri) Remote security group that this rule references, if any
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Create server group

Create a new server group for the tenant.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/openstack-tenants/a1b2c3d4-e5f6-7890-abcd-ef1234567890/create_server_group/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-openstack-tenant"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.open_stack_server_group_request import OpenStackServerGroupRequest # (1)
from waldur_api_client.api.openstack_tenants import openstack_tenants_create_server_group # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OpenStackServerGroupRequest(
    name="my-awesome-openstack-tenant"
)
response = openstack_tenants_create_server_group.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OpenStackServerGroupRequest
  2. API Source: openstack_tenants_create_server_group
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { openstackTenantsCreateServerGroup } from 'waldur-js-client';

try {
  const response = await openstackTenantsCreateServerGroup({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-openstack-tenant"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
name string ✓
description string
policy any affinity — all instances are placed on the same hypervisor. anti-affinity — all instances are placed on different hypervisors. soft-affinity — instances are placed on the same hypervisor if possible, but not enforced. soft-anti-affinity — instances are placed on different hypervisors if possible, but not enforced.

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
tenant string (uri)
tenant_name string
tenant_uuid string (uuid)
policy any affinity — all instances are placed on the same hypervisor. anti-affinity — all instances are placed on different hypervisors. soft-affinity — instances are placed on the same hypervisor if possible, but not enforced. soft-anti-affinity — instances are placed on different hypervisors if possible, but not enforced.
display_name string
instances array of objects
instances.backend_id string Instance ID in the OpenStack backend
instances.name string
instances.uuid string (uuid)
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Data & Reporting

List backend instances

Return a list of volumes from backend

1
2
3
4
http \
  GET \
  https://api.example.com/api/openstack-tenants/a1b2c3d4-e5f6-7890-abcd-ef1234567890/backend_instances/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.core_states import CoreStates # (1)
from waldur_api_client.api.openstack_tenants import openstack_tenants_backend_instances_list # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_tenants_backend_instances_list.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

for item in response:
    print(item)
  1. Model Source: CoreStates
  2. API Source: openstack_tenants_backend_instances_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackTenantsBackendInstancesList } from 'waldur-js-client';

try {
  const response = await openstackTenantsBackendInstancesList({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type Description
backend_id string Backend ID
can_manage boolean Can manage
customer string (uuid) Customer UUID
customer_abbreviation string Customer abbreviation
customer_name string Customer name
customer_native_name string Customer native name
customer_uuid string (uuid) Customer UUID
description string Description
external_ip string External IP
name string Name
name_exact string Name (exact)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
project string (uuid) Project UUID
project_name string Project name
project_uuid string (uuid) Project UUID
service_settings_name string Service settings name
service_settings_uuid string (uuid) Service settings UUID
state array State
uuid string (uuid) UUID

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
name string
key_name string
start_time string (date-time)
state string
runtime_state string
created string (date-time)
backend_id string Instance ID in the OpenStack backend
availability_zone string
hypervisor_hostname string Name of the hypervisor hosting this instance

List backend volumes

Return a list of volumes from backend

1
2
3
4
http \
  GET \
  https://api.example.com/api/openstack-tenants/a1b2c3d4-e5f6-7890-abcd-ef1234567890/backend_volumes/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.core_states import CoreStates # (1)
from waldur_api_client.api.openstack_tenants import openstack_tenants_backend_volumes_list # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_tenants_backend_volumes_list.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

for item in response:
    print(item)
  1. Model Source: CoreStates
  2. API Source: openstack_tenants_backend_volumes_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackTenantsBackendVolumesList } from 'waldur-js-client';

try {
  const response = await openstackTenantsBackendVolumesList({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type Description
backend_id string Backend ID
can_manage boolean Can manage
customer string (uuid) Customer UUID
customer_abbreviation string Customer abbreviation
customer_name string Customer name
customer_native_name string Customer native name
customer_uuid string (uuid) Customer UUID
description string Description
external_ip string External IP
name string Name
name_exact string Name (exact)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
project string (uuid) Project UUID
project_name string Project name
project_uuid string (uuid) Project UUID
service_settings_name string Service settings name
service_settings_uuid string (uuid) Service settings UUID
state array State
uuid string (uuid) UUID

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
name string
description string
size integer Size in MiB
metadata string Arbitrary key-value pairs associated with the volume
backend_id string Volume ID in the OpenStack backend
type string
bootable boolean Indicates if this volume can be used to boot an instance
runtime_state string
state string
availability_zone string

Remote Actions & Sync

Pull floating IPs

Trigger job to pull floating IPs from remote VPC

1
2
3
4
http \
  POST \
  https://api.example.com/api/openstack-tenants/a1b2c3d4-e5f6-7890-abcd-ef1234567890/pull_floating_ips/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_tenants import openstack_tenants_pull_floating_ips # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_tenants_pull_floating_ips.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openstack_tenants_pull_floating_ips
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackTenantsPullFloatingIps } from 'waldur-js-client';

try {
  const response = await openstackTenantsPullFloatingIps({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

202 - No response body

Pull tenant quotas

It triggers celery job to pull quotas from remote VPC

1
2
3
4
http \
  POST \
  https://api.example.com/api/openstack-tenants/a1b2c3d4-e5f6-7890-abcd-ef1234567890/pull_quotas/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_tenants import openstack_tenants_pull_quotas # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_tenants_pull_quotas.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openstack_tenants_pull_quotas
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackTenantsPullQuotas } from 'waldur-js-client';

try {
  const response = await openstackTenantsPullQuotas({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 - No response body

Pull security groups

Trigger job to pull security groups from remote VPC

1
2
3
4
http \
  POST \
  https://api.example.com/api/openstack-tenants/a1b2c3d4-e5f6-7890-abcd-ef1234567890/pull_security_groups/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_tenants import openstack_tenants_pull_security_groups # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_tenants_pull_security_groups.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openstack_tenants_pull_security_groups
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackTenantsPullSecurityGroups } from 'waldur-js-client';

try {
  const response = await openstackTenantsPullSecurityGroups({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string ID of tenant in the OpenStack backend
access_url string
availability_zone string Optional availability group. Will be used for all instances provisioned in this tenant
internal_network_id string ID of internal network in OpenStack tenant
external_network_id string ID of external network connected to OpenStack tenant
external_network_ref_uuid string (uuid)
external_network_ref_name string
user_username string Username of the tenant user
user_password string Password of the tenant user
quotas array of objects
quotas.name string
quotas.usage integer
quotas.limit integer
default_volume_type_name string Volume type name to use when creating volumes.
skip_creation_of_default_router boolean
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Pull server groups

Trigger job to pull server groups from remote VPC

1
2
3
4
http \
  POST \
  https://api.example.com/api/openstack-tenants/a1b2c3d4-e5f6-7890-abcd-ef1234567890/pull_server_groups/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_tenants import openstack_tenants_pull_server_groups # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_tenants_pull_server_groups.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openstack_tenants_pull_server_groups
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackTenantsPullServerGroups } from 'waldur-js-client';

try {
  const response = await openstackTenantsPullServerGroups({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string ID of tenant in the OpenStack backend
access_url string
availability_zone string Optional availability group. Will be used for all instances provisioned in this tenant
internal_network_id string ID of internal network in OpenStack tenant
external_network_id string ID of external network connected to OpenStack tenant
external_network_ref_uuid string (uuid)
external_network_ref_name string
user_username string Username of the tenant user
user_password string Password of the tenant user
quotas array of objects
quotas.name string
quotas.usage integer
quotas.limit integer
default_volume_type_name string Volume type name to use when creating volumes.
skip_creation_of_default_router boolean
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Other Actions

Batch update security groups for a tenant.

1
2
3
4
5
6
    * Security groups with UUIDs are updated.
    * Security groups without UUIDs are created.
    * Security groups existing in the tenant but not present in the request are deleted.
    * Rules for created/updated security groups are replaced.

    To reference a remote group within a rule, use 'remote_group_name' field.

1
2
3
4
echo '[{"uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "name": "my-awesome-openstack-tenant", "description": "A sample description.", "rules": []}]' | http \
  POST \
  https://api.example.com/api/openstack-tenants/a1b2c3d4-e5f6-7890-abcd-ef1234567890/push_security_groups/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_tenants import openstack_tenants_push_security_groups # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_tenants_push_security_groups.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openstack_tenants_push_security_groups
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { openstackTenantsPushSecurityGroups } from 'waldur-js-client';

try {
  const response = await openstackTenantsPushSecurityGroups({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: [{"uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "name": "my-awesome-openstack-tenant", "description": "A sample description.", "rules": []}]
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

The request body is an array of objects, where each object has the following structure:

Field Type Required Description
uuid string (uuid)
name string ✓
description string
rules array of objects
rules.ethertype any IP protocol version - either 'IPv4' or 'IPv6'
rules.direction any Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing)
rules.protocol any The network protocol (TCP, UDP, ICMP, or empty for any protocol)
rules.from_port integer Starting port number in the range (1-65535)
rules.to_port integer Ending port number in the range (1-65535)
rules.cidr string CIDR notation for the source/destination network address range
rules.description string
rules.remote_group_name string
Constraints: write-only
rules.remote_group string (uri)

200 - No response body

Mark resource as ERRED

Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.

1
2
3
4
http \
  POST \
  https://api.example.com/api/openstack-tenants/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_erred/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.set_erred_request import SetErredRequest # (1)
from waldur_api_client.api.openstack_tenants import openstack_tenants_set_erred # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = SetErredRequest()
response = openstack_tenants_set_erred.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: SetErredRequest
  2. API Source: openstack_tenants_set_erred
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackTenantsSetErred } from 'waldur-js-client';

try {
  const response = await openstackTenantsSetErred({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
error_message string
error_traceback string

200 -

Field Type
detail string

Mark resource as OK

Manually transition the resource to OK state and clear error fields. Staff-only operation.

1
2
3
4
http \
  POST \
  https://api.example.com/api/openstack-tenants/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_ok/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_tenants import openstack_tenants_set_ok # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_tenants_set_ok.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openstack_tenants_set_ok
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackTenantsSetOk } from 'waldur-js-client';

try {
  const response = await openstackTenantsSetOk({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
detail string

Openstack Volume Availability Zones

Operations Summary

Method Endpoint Description
GET /api/openstack-volume-availability-zones/ List volume availability zones
GET /api/openstack-volume-availability-zones/{uuid}/ Get volume availability zone details

List volume availability zones

Get a list of volume availability zones.

1
2
3
4
http \
  GET \
  https://api.example.com/api/openstack-volume-availability-zones/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_volume_availability_zones import openstack_volume_availability_zones_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_volume_availability_zones_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: openstack_volume_availability_zones_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { openstackVolumeAvailabilityZonesList } from 'waldur-js-client';

try {
  const response = await openstackVolumeAvailabilityZonesList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
name string Name
name_exact string Name (exact)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
settings string (uri) Settings URL
settings_uuid string (uuid) Settings UUID
tenant string (uri) Tenant URL
tenant_uuid string (uuid) Tenant UUID

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
url string (uri)
uuid string (uuid)
name string
settings string (uri)
available boolean

Get volume availability zone details

Retrieve details of a specific volume availability zone.

1
2
3
4
http \
  GET \
  https://api.example.com/api/openstack-volume-availability-zones/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_volume_availability_zones import openstack_volume_availability_zones_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_volume_availability_zones_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openstack_volume_availability_zones_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackVolumeAvailabilityZonesRetrieve } from 'waldur-js-client';

try {
  const response = await openstackVolumeAvailabilityZonesRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
url string (uri)
uuid string (uuid)
name string
settings string (uri)
available boolean

Openstack Volume Types

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/openstack-volume-types/ List volume types
GET /api/openstack-volume-types/{uuid}/ Get volume type details
Other Actions
GET /api/openstack-volume-types/names/ List unique volume type names

Core CRUD

List volume types

Get a list of available volume types.

1
2
3
4
http \
  GET \
  https://api.example.com/api/openstack-volume-types/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_volume_types import openstack_volume_types_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_volume_types_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: openstack_volume_types_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { openstackVolumeTypesList } from 'waldur-js-client';

try {
  const response = await openstackVolumeTypesList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
name string Name
name_exact string Name (exact)
offering_uuid string (uuid) Offering UUID
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
settings string (uri) Settings URL
settings_uuid string (uuid) Settings UUID
tenant string (uri) Tenant URL
tenant_uuid string (uuid) Tenant UUID

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
url string (uri)
uuid string (uuid)
name string
description string
settings string (uri)

Get volume type details

Retrieve details of a specific volume type.

1
2
3
4
http \
  GET \
  https://api.example.com/api/openstack-volume-types/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_volume_types import openstack_volume_types_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_volume_types_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openstack_volume_types_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackVolumeTypesRetrieve } from 'waldur-js-client';

try {
  const response = await openstackVolumeTypesRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
url string (uri)
uuid string (uuid)
name string
description string
settings string (uri)

Other Actions

List unique volume type names

Return a list of unique volume type names.

1
2
3
4
http \
  GET \
  https://api.example.com/api/openstack-volume-types/names/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_volume_types import openstack_volume_types_names_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_volume_types_names_retrieve.sync(client=client)

for item in response:
    print(item)
  1. API Source: openstack_volume_types_names_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { openstackVolumeTypesNamesRetrieve } from 'waldur-js-client';

try {
  const response = await openstackVolumeTypesNamesRetrieve({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

200 -

Openstack Volumes

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/openstack-volumes/ List volumes
GET /api/openstack-volumes/{uuid}/ Get volume details
POST /api/openstack-volumes/{uuid}/pull/ Synchronize resource state
POST /api/openstack-volumes/{uuid}/unlink/ Unlink resource
PUT /api/openstack-volumes/{uuid}/ Update volume
PATCH /api/openstack-volumes/{uuid}/ Partially update volume
Other Actions
POST /api/openstack-volumes/{uuid}/attach/ Attach volume to instance
POST /api/openstack-volumes/{uuid}/detach/ Detach volume from instance
POST /api/openstack-volumes/{uuid}/extend/ Extend volume size
POST /api/openstack-volumes/{uuid}/retype/ Change volume type
POST /api/openstack-volumes/{uuid}/set_erred/ Mark resource as ERRED
POST /api/openstack-volumes/{uuid}/set_ok/ Mark resource as OK
POST /api/openstack-volumes/{uuid}/snapshot/ Create volume snapshot

Core CRUD

List volumes

Get a list of volumes.

1
2
3
4
http \
  GET \
  https://api.example.com/api/openstack-volumes/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.core_states import CoreStates # (1)
from waldur_api_client.models.open_stack_volume_field_enum import OpenStackVolumeFieldEnum # (2)
from waldur_api_client.api.openstack_volumes import openstack_volumes_list # (3)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_volumes_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: CoreStates
  2. Model Source: OpenStackVolumeFieldEnum
  3. API Source: openstack_volumes_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { openstackVolumesList } from 'waldur-js-client';

try {
  const response = await openstackVolumesList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
attach_instance_uuid string (uuid) Filter for attachment to instance UUID
availability_zone_name string Availability zone name
backend_id string Backend ID
can_manage boolean Can manage
customer string (uuid) Customer UUID
customer_abbreviation string Customer abbreviation
customer_name string Customer name
customer_native_name string Customer native name
customer_uuid string (uuid) Customer UUID
description string Description
external_ip string External IP
field array
instance string (uri) Instance URL
instance_uuid string (uuid) Instance UUID
name string Name
name_exact string Name (exact)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
project string (uuid) Project UUID
project_name string Project name
project_uuid string (uuid) Project UUID
runtime_state string
service_settings_name string Service settings name
service_settings_uuid string (uuid) Service settings UUID
snapshot string (uri) Snapshot URL
snapshot_uuid string (uuid) Snapshot UUID
state array State
tenant string (uri) Tenant URL
tenant_uuid string (uuid) Tenant UUID
uuid string (uuid) UUID

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string Volume ID in the OpenStack backend
access_url string
source_snapshot string (uri) Snapshot that this volume was created from, if any
size integer Size in MiB
bootable boolean Indicates if this volume can be used to boot an instance
metadata any
image string (uri) Image that this volume was created from, if any
image_metadata string Metadata of the image this volume was created from
image_name string Name of the image this volume was created from
type string (uri) Type of the volume (e.g. SSD, HDD)
type_name string
runtime_state string
availability_zone string (uri) Availability zone where this volume is located
availability_zone_name string
device string Name of volume as instance device e.g. /dev/vdb.
action string
action_details any
instance string (uri) Instance that this volume is attached to, if any
instance_name string
instance_marketplace_uuid string (uuid)
tenant string (uri)
tenant_uuid string (uuid)
extend_enabled boolean
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Get volume details

Retrieve details of a specific volume.

1
2
3
4
http \
  GET \
  https://api.example.com/api/openstack-volumes/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.open_stack_volume_field_enum import OpenStackVolumeFieldEnum # (1)
from waldur_api_client.api.openstack_volumes import openstack_volumes_retrieve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_volumes_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. Model Source: OpenStackVolumeFieldEnum
  2. API Source: openstack_volumes_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackVolumesRetrieve } from 'waldur-js-client';

try {
  const response = await openstackVolumesRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type
field array

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string Volume ID in the OpenStack backend
access_url string
source_snapshot string (uri) Snapshot that this volume was created from, if any
size integer Size in MiB
bootable boolean Indicates if this volume can be used to boot an instance
metadata any
image string (uri) Image that this volume was created from, if any
image_metadata string Metadata of the image this volume was created from
image_name string Name of the image this volume was created from
type string (uri) Type of the volume (e.g. SSD, HDD)
type_name string
runtime_state string
availability_zone string (uri) Availability zone where this volume is located
availability_zone_name string
device string Name of volume as instance device e.g. /dev/vdb.
action string
action_details any
instance string (uri) Instance that this volume is attached to, if any
instance_name string
instance_marketplace_uuid string (uuid)
tenant string (uri)
tenant_uuid string (uuid)
extend_enabled boolean
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Synchronize resource state

Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.

1
2
3
4
http \
  POST \
  https://api.example.com/api/openstack-volumes/a1b2c3d4-e5f6-7890-abcd-ef1234567890/pull/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_volumes import openstack_volumes_pull # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_volumes_pull.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openstack_volumes_pull
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackVolumesPull } from 'waldur-js-client';

try {
  const response = await openstackVolumesPull({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

202 -

Field Type
detail string

409 -

Field Type
detail string

Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state.

1
2
3
4
http \
  POST \
  https://api.example.com/api/openstack-volumes/a1b2c3d4-e5f6-7890-abcd-ef1234567890/unlink/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_volumes import openstack_volumes_unlink # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_volumes_unlink.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openstack_volumes_unlink
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackVolumesUnlink } from 'waldur-js-client';

try {
  const response = await openstackVolumesUnlink({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Update volume

Update an existing volume.

1
2
3
4
5
http \
  PUT \
  https://api.example.com/api/openstack-volumes/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-openstack-volume"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.open_stack_volume_request import OpenStackVolumeRequest # (1)
from waldur_api_client.api.openstack_volumes import openstack_volumes_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OpenStackVolumeRequest(
    name="my-awesome-openstack-volume"
)
response = openstack_volumes_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OpenStackVolumeRequest
  2. API Source: openstack_volumes_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { openstackVolumesUpdate } from 'waldur-js-client';

try {
  const response = await openstackVolumesUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-openstack-volume"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
name string ✓
description string
bootable boolean Indicates if this volume can be used to boot an instance

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string Volume ID in the OpenStack backend
access_url string
source_snapshot string (uri) Snapshot that this volume was created from, if any
size integer Size in MiB
bootable boolean Indicates if this volume can be used to boot an instance
metadata any
image string (uri) Image that this volume was created from, if any
image_metadata string Metadata of the image this volume was created from
image_name string Name of the image this volume was created from
type string (uri) Type of the volume (e.g. SSD, HDD)
type_name string
runtime_state string
availability_zone string (uri) Availability zone where this volume is located
availability_zone_name string
device string Name of volume as instance device e.g. /dev/vdb.
action string
action_details any
instance string (uri) Instance that this volume is attached to, if any
instance_name string
instance_marketplace_uuid string (uuid)
tenant string (uri)
tenant_uuid string (uuid)
extend_enabled boolean
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Partially update volume

Update specific fields of a volume.

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/openstack-volumes/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_open_stack_volume_request import PatchedOpenStackVolumeRequest # (1)
from waldur_api_client.api.openstack_volumes import openstack_volumes_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedOpenStackVolumeRequest()
response = openstack_volumes_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedOpenStackVolumeRequest
  2. API Source: openstack_volumes_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackVolumesPartialUpdate } from 'waldur-js-client';

try {
  const response = await openstackVolumesPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
name string
description string
bootable boolean Indicates if this volume can be used to boot an instance

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string Volume ID in the OpenStack backend
access_url string
source_snapshot string (uri) Snapshot that this volume was created from, if any
size integer Size in MiB
bootable boolean Indicates if this volume can be used to boot an instance
metadata any
image string (uri) Image that this volume was created from, if any
image_metadata string Metadata of the image this volume was created from
image_name string Name of the image this volume was created from
type string (uri) Type of the volume (e.g. SSD, HDD)
type_name string
runtime_state string
availability_zone string (uri) Availability zone where this volume is located
availability_zone_name string
device string Name of volume as instance device e.g. /dev/vdb.
action string
action_details any
instance string (uri) Instance that this volume is attached to, if any
instance_name string
instance_marketplace_uuid string (uuid)
tenant string (uri)
tenant_uuid string (uuid)
extend_enabled boolean
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Other Actions

Attach volume to instance

Attach volume to instance

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/openstack-volumes/a1b2c3d4-e5f6-7890-abcd-ef1234567890/attach/ \
  Authorization:"Token YOUR_API_TOKEN" \
  instance="https://api.example.com/api/instance/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.volume_attach_request import VolumeAttachRequest # (1)
from waldur_api_client.api.openstack_volumes import openstack_volumes_attach # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = VolumeAttachRequest(
    instance="https://api.example.com/api/instance/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = openstack_volumes_attach.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: VolumeAttachRequest
  2. API Source: openstack_volumes_attach
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { openstackVolumesAttach } from 'waldur-js-client';

try {
  const response = await openstackVolumesAttach({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "instance": "https://api.example.com/api/instance/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
instance string (uri) ✓ Instance that this volume is attached to, if any

200 - No response body

Detach volume from instance

Detach instance from volume

1
2
3
4
http \
  POST \
  https://api.example.com/api/openstack-volumes/a1b2c3d4-e5f6-7890-abcd-ef1234567890/detach/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_volumes import openstack_volumes_detach # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_volumes_detach.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openstack_volumes_detach
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackVolumesDetach } from 'waldur-js-client';

try {
  const response = await openstackVolumesDetach({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 - No response body

Extend volume size

Increase volume size

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/openstack-volumes/a1b2c3d4-e5f6-7890-abcd-ef1234567890/extend/ \
  Authorization:"Token YOUR_API_TOKEN" \
  disk_size=20480

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.open_stack_volume_extend_request import OpenStackVolumeExtendRequest # (1)
from waldur_api_client.api.openstack_volumes import openstack_volumes_extend # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OpenStackVolumeExtendRequest(
    disk_size=20480
)
response = openstack_volumes_extend.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OpenStackVolumeExtendRequest
  2. API Source: openstack_volumes_extend
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { openstackVolumesExtend } from 'waldur-js-client';

try {
  const response = await openstackVolumesExtend({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "disk_size": 20480
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
disk_size integer ✓

200 - No response body

Change volume type

Retype detached volume

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/openstack-volumes/a1b2c3d4-e5f6-7890-abcd-ef1234567890/retype/ \
  Authorization:"Token YOUR_API_TOKEN" \
  type="https://api.example.com/api/type/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.open_stack_volume_retype_request import OpenStackVolumeRetypeRequest # (1)
from waldur_api_client.api.openstack_volumes import openstack_volumes_retype # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OpenStackVolumeRetypeRequest(
    type="https://api.example.com/api/type/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = openstack_volumes_retype.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OpenStackVolumeRetypeRequest
  2. API Source: openstack_volumes_retype
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { openstackVolumesRetype } from 'waldur-js-client';

try {
  const response = await openstackVolumesRetype({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "type": "https://api.example.com/api/type/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
type string (uri) ✓

200 - No response body

Mark resource as ERRED

Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.

1
2
3
4
http \
  POST \
  https://api.example.com/api/openstack-volumes/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_erred/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.set_erred_request import SetErredRequest # (1)
from waldur_api_client.api.openstack_volumes import openstack_volumes_set_erred # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = SetErredRequest()
response = openstack_volumes_set_erred.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: SetErredRequest
  2. API Source: openstack_volumes_set_erred
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackVolumesSetErred } from 'waldur-js-client';

try {
  const response = await openstackVolumesSetErred({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
error_message string
error_traceback string

200 -

Field Type
detail string

Mark resource as OK

Manually transition the resource to OK state and clear error fields. Staff-only operation.

1
2
3
4
http \
  POST \
  https://api.example.com/api/openstack-volumes/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_ok/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_volumes import openstack_volumes_set_ok # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_volumes_set_ok.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openstack_volumes_set_ok
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackVolumesSetOk } from 'waldur-js-client';

try {
  const response = await openstackVolumesSetOk({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
detail string

Create volume snapshot

Create snapshot from volume

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/openstack-volumes/a1b2c3d4-e5f6-7890-abcd-ef1234567890/snapshot/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-openstack-volume"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.open_stack_snapshot_request import OpenStackSnapshotRequest # (1)
from waldur_api_client.api.openstack_volumes import openstack_volumes_snapshot # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OpenStackSnapshotRequest(
    name="my-awesome-openstack-volume"
)
response = openstack_volumes_snapshot.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OpenStackSnapshotRequest
  2. API Source: openstack_volumes_snapshot
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { openstackVolumesSnapshot } from 'waldur-js-client';

try {
  const response = await openstackVolumesSnapshot({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-openstack-volume"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
name string ✓
description string
metadata any
kept_until string (date-time) Guaranteed time of snapshot retention. If null - keep forever.

201 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string Snapshot ID in the OpenStack backend
access_url string
source_volume string (uri) Volume from which this snapshot was created
size integer Size in MiB
metadata any
runtime_state string
source_volume_name string
source_volume_marketplace_uuid string (uuid)
action string
action_details any
restorations array of objects
restorations.uuid string (uuid)
restorations.created string (date-time)
restorations.description string New volume description.
restorations.volume string (uri) Volume that is being restored from the snapshot
restorations.volume_name string
restorations.volume_state string
restorations.volume_runtime_state string
restorations.volume_size integer Size in MiB
restorations.volume_device string Name of volume as instance device e.g. /dev/vdb.
kept_until string (date-time) Guaranteed time of snapshot retention. If null - keep forever.
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Rancher

Rancher Apps

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/rancher-apps/ List Rancher Apps
GET /api/rancher-apps/{uuid}/ Retrieve
POST /api/rancher-apps/ Create
POST /api/rancher-apps/{uuid}/pull/ Synchronize resource state
POST /api/rancher-apps/{uuid}/unlink/ Unlink resource
PUT /api/rancher-apps/{uuid}/ Update
PATCH /api/rancher-apps/{uuid}/ Partial Update
DELETE /api/rancher-apps/{uuid}/ Delete
Other Actions
POST /api/rancher-apps/{uuid}/set_erred/ Mark resource as ERRED
POST /api/rancher-apps/{uuid}/set_ok/ Mark resource as OK

Core CRUD

List Rancher Apps

1
2
3
4
http \
  GET \
  https://api.example.com/api/rancher-apps/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.core_states import CoreStates # (1)
from waldur_api_client.models.rancher_application_field_enum import RancherApplicationFieldEnum # (2)
from waldur_api_client.api.rancher_apps import rancher_apps_list # (3)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = rancher_apps_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: CoreStates
  2. Model Source: RancherApplicationFieldEnum
  3. API Source: rancher_apps_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { rancherAppsList } from 'waldur-js-client';

try {
  const response = await rancherAppsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
backend_id string Backend ID
can_manage boolean Can manage
cluster_uuid string (uuid)
customer string (uuid) Customer UUID
customer_abbreviation string Customer abbreviation
customer_name string Customer name
customer_native_name string Customer native name
customer_uuid string (uuid) Customer UUID
description string Description
external_ip string External IP
field array
name string Name
name_exact string Name (exact)
namespace_uuid string (uuid)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
project string (uuid) Project UUID
project_name string Project name
project_uuid string (uuid)
service_settings_name string Service settings name
service_settings_uuid string (uuid) Service settings UUID
state array State
template_uuid string (uuid)
uuid string (uuid) UUID

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
runtime_state string
template string (uri)
rancher_project string (uri)
namespace string (uri)
version string
answers object (free-form)
rancher_project_name string
catalog_name string
template_name string
external_url string
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/rancher-apps/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.rancher_application_field_enum import RancherApplicationFieldEnum # (1)
from waldur_api_client.api.rancher_apps import rancher_apps_retrieve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = rancher_apps_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. Model Source: RancherApplicationFieldEnum
  2. API Source: rancher_apps_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { rancherAppsRetrieve } from 'waldur-js-client';

try {
  const response = await rancherAppsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type
field array

200 -

Field Type
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
runtime_state string
template string (uri)
rancher_project string (uri)
namespace string (uri)
version string
answers object (free-form)
rancher_project_name string
catalog_name string
template_name string
external_url string
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Create

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
http \
  POST \
  https://api.example.com/api/rancher-apps/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-rancher-app" \
  service_settings="https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  template="https://api.example.com/api/template/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  rancher_project="https://api.example.com/api/rancher-project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  version="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.rancher_application_request import RancherApplicationRequest # (1)
from waldur_api_client.api.rancher_apps import rancher_apps_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = RancherApplicationRequest(
    name="my-awesome-rancher-app",
    service_settings="https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    template="https://api.example.com/api/template/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    rancher_project="https://api.example.com/api/rancher-project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    version="string-value"
)
response = rancher_apps_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: RancherApplicationRequest
  2. API Source: rancher_apps_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
import { rancherAppsCreate } from 'waldur-js-client';

try {
  const response = await rancherAppsCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "name": "my-awesome-rancher-app",
    "service_settings": "https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "project": "https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "template": "https://api.example.com/api/template/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "rancher_project": "https://api.example.com/api/rancher-project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "version": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required
name string ✓
description string
service_settings string (uri) ✓
project string (uri) ✓
error_message string
error_traceback string
backend_id string
runtime_state string
template string (uri) ✓
rancher_project string (uri) ✓
namespace string (uri)
namespace_name string
version string ✓
answers object (free-form)

201 -

Field Type
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
runtime_state string
template string (uri)
rancher_project string (uri)
namespace string (uri)
version string
answers object (free-form)
rancher_project_name string
catalog_name string
template_name string
external_url string
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Synchronize resource state

Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.

1
2
3
4
http \
  POST \
  https://api.example.com/api/rancher-apps/a1b2c3d4-e5f6-7890-abcd-ef1234567890/pull/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.rancher_apps import rancher_apps_pull # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = rancher_apps_pull.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: rancher_apps_pull
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { rancherAppsPull } from 'waldur-js-client';

try {
  const response = await rancherAppsPull({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

202 -

Field Type
detail string

409 -

Field Type
detail string

Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state.

1
2
3
4
http \
  POST \
  https://api.example.com/api/rancher-apps/a1b2c3d4-e5f6-7890-abcd-ef1234567890/unlink/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.rancher_apps import rancher_apps_unlink # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = rancher_apps_unlink.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: rancher_apps_unlink
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { rancherAppsUnlink } from 'waldur-js-client';

try {
  const response = await rancherAppsUnlink({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Update

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
http \
  PUT \
  https://api.example.com/api/rancher-apps/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-rancher-app" \
  service_settings="https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  template="https://api.example.com/api/template/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  rancher_project="https://api.example.com/api/rancher-project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  version="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.rancher_application_request import RancherApplicationRequest # (1)
from waldur_api_client.api.rancher_apps import rancher_apps_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = RancherApplicationRequest(
    name="my-awesome-rancher-app",
    service_settings="https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    template="https://api.example.com/api/template/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    rancher_project="https://api.example.com/api/rancher-project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    version="string-value"
)
response = rancher_apps_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: RancherApplicationRequest
  2. API Source: rancher_apps_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
import { rancherAppsUpdate } from 'waldur-js-client';

try {
  const response = await rancherAppsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-rancher-app",
    "service_settings": "https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "project": "https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "template": "https://api.example.com/api/template/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "rancher_project": "https://api.example.com/api/rancher-project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "version": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
name string ✓
description string
service_settings string (uri) ✓
project string (uri) ✓
error_message string
error_traceback string
backend_id string
runtime_state string
template string (uri) ✓
rancher_project string (uri) ✓
namespace string (uri)
namespace_name string
version string ✓
answers object (free-form)

200 -

Field Type
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
runtime_state string
template string (uri)
rancher_project string (uri)
namespace string (uri)
version string
answers object (free-form)
rancher_project_name string
catalog_name string
template_name string
external_url string
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/rancher-apps/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_rancher_application_request import PatchedRancherApplicationRequest # (1)
from waldur_api_client.api.rancher_apps import rancher_apps_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedRancherApplicationRequest()
response = rancher_apps_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedRancherApplicationRequest
  2. API Source: rancher_apps_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { rancherAppsPartialUpdate } from 'waldur-js-client';

try {
  const response = await rancherAppsPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
name string
description string
service_settings string (uri)
project string (uri)
error_message string
error_traceback string
backend_id string
runtime_state string
template string (uri)
rancher_project string (uri)
namespace string (uri)
namespace_name string
version string
answers object (free-form)

200 -

Field Type
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
runtime_state string
template string (uri)
rancher_project string (uri)
namespace string (uri)
version string
answers object (free-form)
rancher_project_name string
catalog_name string
template_name string
external_url string
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/rancher-apps/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.rancher_apps import rancher_apps_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = rancher_apps_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: rancher_apps_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { rancherAppsDestroy } from 'waldur-js-client';

try {
  const response = await rancherAppsDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Other Actions

Mark resource as ERRED

Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.

1
2
3
4
http \
  POST \
  https://api.example.com/api/rancher-apps/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_erred/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.set_erred_request import SetErredRequest # (1)
from waldur_api_client.api.rancher_apps import rancher_apps_set_erred # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = SetErredRequest()
response = rancher_apps_set_erred.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: SetErredRequest
  2. API Source: rancher_apps_set_erred
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { rancherAppsSetErred } from 'waldur-js-client';

try {
  const response = await rancherAppsSetErred({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
error_message string
error_traceback string

200 -

Field Type
detail string

Mark resource as OK

Manually transition the resource to OK state and clear error fields. Staff-only operation.

1
2
3
4
http \
  POST \
  https://api.example.com/api/rancher-apps/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_ok/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.rancher_apps import rancher_apps_set_ok # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = rancher_apps_set_ok.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: rancher_apps_set_ok
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { rancherAppsSetOk } from 'waldur-js-client';

try {
  const response = await rancherAppsSetOk({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
detail string

Rancher Catalogs

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/rancher-catalogs/ List Rancher Catalogs
GET /api/rancher-catalogs/{uuid}/ Retrieve
POST /api/rancher-catalogs/ Create
PUT /api/rancher-catalogs/{uuid}/ Update
PATCH /api/rancher-catalogs/{uuid}/ Partial Update
DELETE /api/rancher-catalogs/{uuid}/ Delete
Other Actions
POST /api/rancher-catalogs/{uuid}/refresh/ Refresh

Core CRUD

List Rancher Catalogs

1
2
3
4
http \
  GET \
  https://api.example.com/api/rancher-catalogs/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.rancher_catalogs import rancher_catalogs_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = rancher_catalogs_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: rancher_catalogs_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { rancherCatalogsList } from 'waldur-js-client';

try {
  const response = await rancherCatalogsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
uuid string (uuid)
url string (uri)
created string (date-time)
modified string (date-time)
name string
description string
catalog_url string (uri)
branch string
commit string
runtime_state string
scope string
scope_type any

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/rancher-catalogs/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.rancher_catalogs import rancher_catalogs_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = rancher_catalogs_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: rancher_catalogs_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { rancherCatalogsRetrieve } from 'waldur-js-client';

try {
  const response = await rancherCatalogsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
uuid string (uuid)
url string (uri)
created string (date-time)
modified string (date-time)
name string
description string
catalog_url string (uri)
branch string
commit string
runtime_state string
scope string
scope_type any

Create

1
2
3
4
5
6
7
8
http \
  POST \
  https://api.example.com/api/rancher-catalogs/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-rancher-catalog" \
  catalog_url="https://api.example.com/api/catalog-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  branch="string-value" \
  scope="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.rancher_catalog_create_request import RancherCatalogCreateRequest # (1)
from waldur_api_client.api.rancher_catalogs import rancher_catalogs_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = RancherCatalogCreateRequest(
    name="my-awesome-rancher-catalog",
    catalog_url="https://api.example.com/api/catalog-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    branch="string-value",
    scope="string-value"
)
response = rancher_catalogs_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: RancherCatalogCreateRequest
  2. API Source: rancher_catalogs_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { rancherCatalogsCreate } from 'waldur-js-client';

try {
  const response = await rancherCatalogsCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "name": "my-awesome-rancher-catalog",
    "catalog_url": "https://api.example.com/api/catalog-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "branch": "string-value",
    "scope": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required
name string ✓
description string
catalog_url string (uri) ✓
branch string ✓
scope string ✓
username string
password string

201 -

Field Type
uuid string (uuid)
url string (uri)
created string (date-time)
modified string (date-time)
name string
description string
catalog_url string (uri)
branch string
commit string
runtime_state string
scope string
scope_type any
username string
password string

Update

1
2
3
4
5
6
7
8
http \
  PUT \
  https://api.example.com/api/rancher-catalogs/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-rancher-catalog" \
  catalog_url="https://api.example.com/api/catalog-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  branch="string-value" \
  scope="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.rancher_catalog_update_request import RancherCatalogUpdateRequest # (1)
from waldur_api_client.api.rancher_catalogs import rancher_catalogs_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = RancherCatalogUpdateRequest(
    name="my-awesome-rancher-catalog",
    catalog_url="https://api.example.com/api/catalog-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    branch="string-value",
    scope="string-value"
)
response = rancher_catalogs_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: RancherCatalogUpdateRequest
  2. API Source: rancher_catalogs_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
import { rancherCatalogsUpdate } from 'waldur-js-client';

try {
  const response = await rancherCatalogsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-rancher-catalog",
    "catalog_url": "https://api.example.com/api/catalog-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "branch": "string-value",
    "scope": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
name string ✓
description string
catalog_url string (uri) ✓
branch string ✓
scope string ✓

200 -

Field Type
uuid string (uuid)
url string (uri)
created string (date-time)
modified string (date-time)
name string
description string
catalog_url string (uri)
branch string
commit string
runtime_state string
scope string
scope_type any

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/rancher-catalogs/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_rancher_catalog_request import PatchedRancherCatalogRequest # (1)
from waldur_api_client.api.rancher_catalogs import rancher_catalogs_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedRancherCatalogRequest()
response = rancher_catalogs_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedRancherCatalogRequest
  2. API Source: rancher_catalogs_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { rancherCatalogsPartialUpdate } from 'waldur-js-client';

try {
  const response = await rancherCatalogsPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
name string
description string
catalog_url string (uri)
branch string
scope string

200 -

Field Type
uuid string (uuid)
url string (uri)
created string (date-time)
modified string (date-time)
name string
description string
catalog_url string (uri)
branch string
commit string
runtime_state string
scope string
scope_type any

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/rancher-catalogs/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.rancher_catalogs import rancher_catalogs_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = rancher_catalogs_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: rancher_catalogs_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { rancherCatalogsDestroy } from 'waldur-js-client';

try {
  const response = await rancherCatalogsDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Other Actions

Refresh

1
2
3
4
5
6
7
8
http \
  POST \
  https://api.example.com/api/rancher-catalogs/a1b2c3d4-e5f6-7890-abcd-ef1234567890/refresh/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-rancher-catalog" \
  catalog_url="https://api.example.com/api/catalog-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  branch="string-value" \
  scope="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.rancher_catalog_request import RancherCatalogRequest # (1)
from waldur_api_client.api.rancher_catalogs import rancher_catalogs_refresh # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = RancherCatalogRequest(
    name="my-awesome-rancher-catalog",
    catalog_url="https://api.example.com/api/catalog-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    branch="string-value",
    scope="string-value"
)
response = rancher_catalogs_refresh.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: RancherCatalogRequest
  2. API Source: rancher_catalogs_refresh
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
import { rancherCatalogsRefresh } from 'waldur-js-client';

try {
  const response = await rancherCatalogsRefresh({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-rancher-catalog",
    "catalog_url": "https://api.example.com/api/catalog-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "branch": "string-value",
    "scope": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
name string ✓
description string
catalog_url string (uri) ✓
branch string ✓
scope string ✓

200 -

Field Type
uuid string (uuid)
url string (uri)
created string (date-time)
modified string (date-time)
name string
description string
catalog_url string (uri)
branch string
commit string
runtime_state string
scope string
scope_type any

Rancher Cluster Security Groups

Operations Summary

Method Endpoint Description
GET /api/rancher-cluster-security-groups/ List Rancher Cluster Security Groups
GET /api/rancher-cluster-security-groups/{uuid}/ Retrieve
PUT /api/rancher-cluster-security-groups/{uuid}/ Update
PATCH /api/rancher-cluster-security-groups/{uuid}/ Partial Update

List Rancher Cluster Security Groups

1
2
3
4
http \
  GET \
  https://api.example.com/api/rancher-cluster-security-groups/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.rancher_cluster_security_groups import rancher_cluster_security_groups_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = rancher_cluster_security_groups_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: rancher_cluster_security_groups_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { rancherClusterSecurityGroupsList } from 'waldur-js-client';

try {
  const response = await rancherClusterSecurityGroupsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
cluster_uuid string (uuid)
name string Name
name_exact string Name (exact)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid)
name string
description string
rules array of objects
rules.uuid string (uuid)
rules.ethertype any IP protocol version - either 'IPv4' or 'IPv6'
rules.direction any Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing)
rules.protocol any The network protocol (TCP, UDP, ICMP, or empty for any protocol)
rules.from_port integer Starting port number in the range (1-65535)
rules.to_port integer Ending port number in the range (1-65535)
rules.cidr string CIDR notation for the source/destination network address range
rules.description string

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/rancher-cluster-security-groups/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.rancher_cluster_security_groups import rancher_cluster_security_groups_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = rancher_cluster_security_groups_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: rancher_cluster_security_groups_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { rancherClusterSecurityGroupsRetrieve } from 'waldur-js-client';

try {
  const response = await rancherClusterSecurityGroupsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
uuid string (uuid)
name string
description string
rules array of objects
rules.uuid string (uuid)
rules.ethertype any IP protocol version - either 'IPv4' or 'IPv6'
rules.direction any Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing)
rules.protocol any The network protocol (TCP, UDP, ICMP, or empty for any protocol)
rules.from_port integer Starting port number in the range (1-65535)
rules.to_port integer Ending port number in the range (1-65535)
rules.cidr string CIDR notation for the source/destination network address range
rules.description string

Update

1
2
3
4
5
http \
  PUT \
  https://api.example.com/api/rancher-cluster-security-groups/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  rules:='[]'

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.cluster_security_group_request import ClusterSecurityGroupRequest # (1)
from waldur_api_client.api.rancher_cluster_security_groups import rancher_cluster_security_groups_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ClusterSecurityGroupRequest(
    rules=[]
)
response = rancher_cluster_security_groups_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ClusterSecurityGroupRequest
  2. API Source: rancher_cluster_security_groups_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { rancherClusterSecurityGroupsUpdate } from 'waldur-js-client';

try {
  const response = await rancherClusterSecurityGroupsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "rules": []
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
rules array of objects ✓
rules.ethertype any IP protocol version - either 'IPv4' or 'IPv6'
rules.direction any Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing)
rules.protocol any The network protocol (TCP, UDP, ICMP, or empty for any protocol)
rules.from_port integer Starting port number in the range (1-65535)
rules.to_port integer Ending port number in the range (1-65535)
rules.cidr string CIDR notation for the source/destination network address range
rules.description string

200 -

Field Type Description
uuid string (uuid)
name string
description string
rules array of objects
rules.uuid string (uuid)
rules.ethertype any IP protocol version - either 'IPv4' or 'IPv6'
rules.direction any Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing)
rules.protocol any The network protocol (TCP, UDP, ICMP, or empty for any protocol)
rules.from_port integer Starting port number in the range (1-65535)
rules.to_port integer Ending port number in the range (1-65535)
rules.cidr string CIDR notation for the source/destination network address range
rules.description string

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/rancher-cluster-security-groups/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_cluster_security_group_request import PatchedClusterSecurityGroupRequest # (1)
from waldur_api_client.api.rancher_cluster_security_groups import rancher_cluster_security_groups_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedClusterSecurityGroupRequest()
response = rancher_cluster_security_groups_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedClusterSecurityGroupRequest
  2. API Source: rancher_cluster_security_groups_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { rancherClusterSecurityGroupsPartialUpdate } from 'waldur-js-client';

try {
  const response = await rancherClusterSecurityGroupsPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
rules array of objects
rules.ethertype any IP protocol version - either 'IPv4' or 'IPv6'
rules.direction any Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing)
rules.protocol any The network protocol (TCP, UDP, ICMP, or empty for any protocol)
rules.from_port integer Starting port number in the range (1-65535)
rules.to_port integer Ending port number in the range (1-65535)
rules.cidr string CIDR notation for the source/destination network address range
rules.description string

200 -

Field Type Description
uuid string (uuid)
name string
description string
rules array of objects
rules.uuid string (uuid)
rules.ethertype any IP protocol version - either 'IPv4' or 'IPv6'
rules.direction any Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing)
rules.protocol any The network protocol (TCP, UDP, ICMP, or empty for any protocol)
rules.from_port integer Starting port number in the range (1-65535)
rules.to_port integer Ending port number in the range (1-65535)
rules.cidr string CIDR notation for the source/destination network address range
rules.description string

Rancher Cluster Templates

Operations Summary

Method Endpoint Description
GET /api/rancher-cluster-templates/ List Rancher Cluster Templates
GET /api/rancher-cluster-templates/{uuid}/ Retrieve

List Rancher Cluster Templates

1
2
3
4
http \
  GET \
  https://api.example.com/api/rancher-cluster-templates/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.rancher_cluster_templates import rancher_cluster_templates_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = rancher_cluster_templates_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: rancher_cluster_templates_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { rancherClusterTemplatesList } from 'waldur-js-client';

try {
  const response = await rancherClusterTemplatesList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
uuid string (uuid)
name string
description string
created string (date-time)
modified string (date-time)
nodes array of objects
nodes.min_vcpu integer
nodes.min_ram integer
nodes.system_volume_size integer
nodes.preferred_volume_type string
nodes.role string

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/rancher-cluster-templates/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.rancher_cluster_templates import rancher_cluster_templates_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = rancher_cluster_templates_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: rancher_cluster_templates_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { rancherClusterTemplatesRetrieve } from 'waldur-js-client';

try {
  const response = await rancherClusterTemplatesRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
uuid string (uuid)
name string
description string
created string (date-time)
modified string (date-time)
nodes array of objects
nodes.min_vcpu integer
nodes.min_ram integer
nodes.system_volume_size integer
nodes.preferred_volume_type string
nodes.role string

Rancher Clusters

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/rancher-clusters/ List Rancher Clusters
GET /api/rancher-clusters/{uuid}/ Retrieve
POST /api/rancher-clusters/{uuid}/create_management_security_group/ Create management security group
POST /api/rancher-clusters/{uuid}/pull/ Synchronize resource state
POST /api/rancher-clusters/{uuid}/unlink/ Unlink resource
PUT /api/rancher-clusters/{uuid}/ Update
PATCH /api/rancher-clusters/{uuid}/ Partial Update
Other Actions
POST /api/rancher-clusters/{uuid}/import_yaml/ Import yaml
POST /api/rancher-clusters/{uuid}/set_erred/ Mark resource as ERRED
POST /api/rancher-clusters/{uuid}/set_ok/ Mark resource as OK

Core CRUD

List Rancher Clusters

1
2
3
4
http \
  GET \
  https://api.example.com/api/rancher-clusters/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.core_states import CoreStates # (1)
from waldur_api_client.models.rancher_cluster_field_enum import RancherClusterFieldEnum # (2)
from waldur_api_client.api.rancher_clusters import rancher_clusters_list # (3)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = rancher_clusters_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: CoreStates
  2. Model Source: RancherClusterFieldEnum
  3. API Source: rancher_clusters_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { rancherClustersList } from 'waldur-js-client';

try {
  const response = await rancherClustersList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
backend_id string Backend ID
can_manage boolean Can manage
customer string (uuid) Customer UUID
customer_abbreviation string Customer abbreviation
customer_name string Customer name
customer_native_name string Customer native name
customer_uuid string (uuid) Customer UUID
description string Description
external_ip string External IP
field array
name string Name
name_exact string Name (exact)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
project string (uuid) Project UUID
project_name string Project name
project_uuid string (uuid) Project UUID
service_settings_name string Service settings name
service_settings_uuid string (uuid) Service settings UUID
state array State
uuid string (uuid) UUID

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
nodes array of objects
nodes.url string (uri)
nodes.role string
Enum: agent, server
nodes.instance string
nodes.created string (date-time)
nodes.modified string (date-time)
nodes.uuid string (uuid)
nodes.error_message string
nodes.error_traceback string
nodes.backend_id string
nodes.initial_data any Initial data for instance creating.
nodes.runtime_state string
nodes.k8s_version string
nodes.docker_version string
nodes.cpu_allocated number (double)
nodes.cpu_total integer
nodes.ram_allocated integer Allocated RAM in Mi.
nodes.ram_total integer Total RAM in Mi.
nodes.pods_allocated integer
nodes.pods_total integer
nodes.labels any
nodes.annotations any
tenant string (uri)
tenant_uuid string (uuid)
vm_project string (uri)
runtime_state string
install_longhorn boolean Longhorn is a distributed block storage deployed on top of Kubernetes cluster
management_security_group string (uri)
public_ips array of objects
public_ips.floating_ip string (uri)
public_ips.floating_ip_uuid string (uuid)
public_ips.ip_address any An IPv4 or IPv6 address.
public_ips.external_ip_address any An IPv4 or IPv6 address.
capacity any Cluster capacity in the format
requested any Cluster requested resources in the format
kubernetes_version string Kubernetes version used in the cluster.
router_ips array of anys
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/rancher-clusters/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.rancher_cluster_field_enum import RancherClusterFieldEnum # (1)
from waldur_api_client.api.rancher_clusters import rancher_clusters_retrieve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = rancher_clusters_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. Model Source: RancherClusterFieldEnum
  2. API Source: rancher_clusters_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { rancherClustersRetrieve } from 'waldur-js-client';

try {
  const response = await rancherClustersRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type
field array

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
nodes array of objects
nodes.url string (uri)
nodes.role string
Enum: agent, server
nodes.instance string
nodes.created string (date-time)
nodes.modified string (date-time)
nodes.uuid string (uuid)
nodes.error_message string
nodes.error_traceback string
nodes.backend_id string
nodes.initial_data any Initial data for instance creating.
nodes.runtime_state string
nodes.k8s_version string
nodes.docker_version string
nodes.cpu_allocated number (double)
nodes.cpu_total integer
nodes.ram_allocated integer Allocated RAM in Mi.
nodes.ram_total integer Total RAM in Mi.
nodes.pods_allocated integer
nodes.pods_total integer
nodes.labels any
nodes.annotations any
tenant string (uri)
tenant_uuid string (uuid)
vm_project string (uri)
runtime_state string
install_longhorn boolean Longhorn is a distributed block storage deployed on top of Kubernetes cluster
management_security_group string (uri)
public_ips array of objects
public_ips.floating_ip string (uri)
public_ips.floating_ip_uuid string (uuid)
public_ips.ip_address any An IPv4 or IPv6 address.
public_ips.external_ip_address any An IPv4 or IPv6 address.
capacity any Cluster capacity in the format
requested any Cluster requested resources in the format
kubernetes_version string Kubernetes version used in the cluster.
router_ips array of anys
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Create management security group

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/rancher-clusters/a1b2c3d4-e5f6-7890-abcd-ef1234567890/create_management_security_group/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-rancher-cluster"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.rancher_cluster_request import RancherClusterRequest # (1)
from waldur_api_client.api.rancher_clusters import rancher_clusters_create_management_security_group # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = RancherClusterRequest(
    name="my-awesome-rancher-cluster"
)
response = rancher_clusters_create_management_security_group.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: RancherClusterRequest
  2. API Source: rancher_clusters_create_management_security_group
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { rancherClustersCreateManagementSecurityGroup } from 'waldur-js-client';

try {
  const response = await rancherClustersCreateManagementSecurityGroup({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-rancher-cluster"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
name string ✓
description string
vm_project string (uri)
ssh_public_key string (uri)
Constraints: write-only
install_longhorn boolean Longhorn is a distributed block storage deployed on top of Kubernetes cluster
Constraints: default: False

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
nodes array of objects
nodes.url string (uri)
nodes.role string
Enum: agent, server
nodes.instance string
nodes.created string (date-time)
nodes.modified string (date-time)
nodes.uuid string (uuid)
nodes.error_message string
nodes.error_traceback string
nodes.backend_id string
nodes.initial_data any Initial data for instance creating.
nodes.runtime_state string
nodes.k8s_version string
nodes.docker_version string
nodes.cpu_allocated number (double)
nodes.cpu_total integer
nodes.ram_allocated integer Allocated RAM in Mi.
nodes.ram_total integer Total RAM in Mi.
nodes.pods_allocated integer
nodes.pods_total integer
nodes.labels any
nodes.annotations any
tenant string (uri)
tenant_uuid string (uuid)
vm_project string (uri)
runtime_state string
install_longhorn boolean Longhorn is a distributed block storage deployed on top of Kubernetes cluster
management_security_group string (uri)
public_ips array of objects
public_ips.floating_ip string (uri)
public_ips.floating_ip_uuid string (uuid)
public_ips.ip_address any An IPv4 or IPv6 address.
public_ips.external_ip_address any An IPv4 or IPv6 address.
capacity any Cluster capacity in the format
requested any Cluster requested resources in the format
kubernetes_version string Kubernetes version used in the cluster.
router_ips array of anys
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Synchronize resource state

Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.

1
2
3
4
http \
  POST \
  https://api.example.com/api/rancher-clusters/a1b2c3d4-e5f6-7890-abcd-ef1234567890/pull/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.rancher_clusters import rancher_clusters_pull # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = rancher_clusters_pull.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: rancher_clusters_pull
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { rancherClustersPull } from 'waldur-js-client';

try {
  const response = await rancherClustersPull({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

202 -

Field Type
detail string

409 -

Field Type
detail string

Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state.

1
2
3
4
http \
  POST \
  https://api.example.com/api/rancher-clusters/a1b2c3d4-e5f6-7890-abcd-ef1234567890/unlink/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.rancher_clusters import rancher_clusters_unlink # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = rancher_clusters_unlink.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: rancher_clusters_unlink
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { rancherClustersUnlink } from 'waldur-js-client';

try {
  const response = await rancherClustersUnlink({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Update

1
2
3
4
5
http \
  PUT \
  https://api.example.com/api/rancher-clusters/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-rancher-cluster"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.rancher_cluster_request import RancherClusterRequest # (1)
from waldur_api_client.api.rancher_clusters import rancher_clusters_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = RancherClusterRequest(
    name="my-awesome-rancher-cluster"
)
response = rancher_clusters_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: RancherClusterRequest
  2. API Source: rancher_clusters_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { rancherClustersUpdate } from 'waldur-js-client';

try {
  const response = await rancherClustersUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-rancher-cluster"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
name string ✓
description string
vm_project string (uri)
ssh_public_key string (uri)
Constraints: write-only
install_longhorn boolean Longhorn is a distributed block storage deployed on top of Kubernetes cluster
Constraints: default: False

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
nodes array of objects
nodes.url string (uri)
nodes.role string
Enum: agent, server
nodes.instance string
nodes.created string (date-time)
nodes.modified string (date-time)
nodes.uuid string (uuid)
nodes.error_message string
nodes.error_traceback string
nodes.backend_id string
nodes.initial_data any Initial data for instance creating.
nodes.runtime_state string
nodes.k8s_version string
nodes.docker_version string
nodes.cpu_allocated number (double)
nodes.cpu_total integer
nodes.ram_allocated integer Allocated RAM in Mi.
nodes.ram_total integer Total RAM in Mi.
nodes.pods_allocated integer
nodes.pods_total integer
nodes.labels any
nodes.annotations any
tenant string (uri)
tenant_uuid string (uuid)
vm_project string (uri)
runtime_state string
install_longhorn boolean Longhorn is a distributed block storage deployed on top of Kubernetes cluster
management_security_group string (uri)
public_ips array of objects
public_ips.floating_ip string (uri)
public_ips.floating_ip_uuid string (uuid)
public_ips.ip_address any An IPv4 or IPv6 address.
public_ips.external_ip_address any An IPv4 or IPv6 address.
capacity any Cluster capacity in the format
requested any Cluster requested resources in the format
kubernetes_version string Kubernetes version used in the cluster.
router_ips array of anys
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/rancher-clusters/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_rancher_cluster_request import PatchedRancherClusterRequest # (1)
from waldur_api_client.api.rancher_clusters import rancher_clusters_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedRancherClusterRequest()
response = rancher_clusters_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedRancherClusterRequest
  2. API Source: rancher_clusters_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { rancherClustersPartialUpdate } from 'waldur-js-client';

try {
  const response = await rancherClustersPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
name string
description string
vm_project string (uri)
ssh_public_key string (uri)
Constraints: write-only
install_longhorn boolean Longhorn is a distributed block storage deployed on top of Kubernetes cluster
Constraints: default: False

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
nodes array of objects
nodes.url string (uri)
nodes.role string
Enum: agent, server
nodes.instance string
nodes.created string (date-time)
nodes.modified string (date-time)
nodes.uuid string (uuid)
nodes.error_message string
nodes.error_traceback string
nodes.backend_id string
nodes.initial_data any Initial data for instance creating.
nodes.runtime_state string
nodes.k8s_version string
nodes.docker_version string
nodes.cpu_allocated number (double)
nodes.cpu_total integer
nodes.ram_allocated integer Allocated RAM in Mi.
nodes.ram_total integer Total RAM in Mi.
nodes.pods_allocated integer
nodes.pods_total integer
nodes.labels any
nodes.annotations any
tenant string (uri)
tenant_uuid string (uuid)
vm_project string (uri)
runtime_state string
install_longhorn boolean Longhorn is a distributed block storage deployed on top of Kubernetes cluster
management_security_group string (uri)
public_ips array of objects
public_ips.floating_ip string (uri)
public_ips.floating_ip_uuid string (uuid)
public_ips.ip_address any An IPv4 or IPv6 address.
public_ips.external_ip_address any An IPv4 or IPv6 address.
capacity any Cluster capacity in the format
requested any Cluster requested resources in the format
kubernetes_version string Kubernetes version used in the cluster.
router_ips array of anys
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Other Actions

Import yaml

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/rancher-clusters/a1b2c3d4-e5f6-7890-abcd-ef1234567890/import_yaml/ \
  Authorization:"Token YOUR_API_TOKEN" \
  yaml="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.rancher_import_yaml_request import RancherImportYamlRequest # (1)
from waldur_api_client.api.rancher_clusters import rancher_clusters_import_yaml # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = RancherImportYamlRequest(
    yaml="string-value"
)
response = rancher_clusters_import_yaml.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: RancherImportYamlRequest
  2. API Source: rancher_clusters_import_yaml
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { rancherClustersImportYaml } from 'waldur-js-client';

try {
  const response = await rancherClustersImportYaml({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "yaml": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
yaml string ✓
default_namespace string (uri)
namespace string (uri)

200 -

Field Type
yaml string
default_namespace string (uri)
namespace string (uri)

Mark resource as ERRED

Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.

1
2
3
4
http \
  POST \
  https://api.example.com/api/rancher-clusters/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_erred/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.set_erred_request import SetErredRequest # (1)
from waldur_api_client.api.rancher_clusters import rancher_clusters_set_erred # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = SetErredRequest()
response = rancher_clusters_set_erred.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: SetErredRequest
  2. API Source: rancher_clusters_set_erred
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { rancherClustersSetErred } from 'waldur-js-client';

try {
  const response = await rancherClustersSetErred({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
error_message string
error_traceback string

200 -

Field Type
detail string

Mark resource as OK

Manually transition the resource to OK state and clear error fields. Staff-only operation.

1
2
3
4
http \
  POST \
  https://api.example.com/api/rancher-clusters/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_ok/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.rancher_clusters import rancher_clusters_set_ok # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = rancher_clusters_set_ok.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: rancher_clusters_set_ok
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { rancherClustersSetOk } from 'waldur-js-client';

try {
  const response = await rancherClustersSetOk({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
detail string

Rancher Hpas

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/rancher-hpas/ List Rancher Hpas
GET /api/rancher-hpas/{uuid}/ Retrieve
POST /api/rancher-hpas/ Create
POST /api/rancher-hpas/{uuid}/pull/ Synchronize resource state
POST /api/rancher-hpas/{uuid}/unlink/ Unlink resource
PUT /api/rancher-hpas/{uuid}/ Update
PATCH /api/rancher-hpas/{uuid}/ Partial Update
DELETE /api/rancher-hpas/{uuid}/ Delete
Other Actions
GET /api/rancher-hpas/{uuid}/yaml/ Yaml
POST /api/rancher-hpas/{uuid}/set_erred/ Mark resource as ERRED
POST /api/rancher-hpas/{uuid}/set_ok/ Mark resource as OK
PUT /api/rancher-hpas/{uuid}/yaml/ Yaml

Core CRUD

List Rancher Hpas

1
2
3
4
http \
  GET \
  https://api.example.com/api/rancher-hpas/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.rancher_hpas import rancher_hpas_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = rancher_hpas_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: rancher_hpas_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { rancherHpasList } from 'waldur-js-client';

try {
  const response = await rancherHpasList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
cluster_uuid string (uuid)
name string Name
name_exact string Name (exact)
namespace_uuid string (uuid)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
project_uuid string (uuid)
settings string (uri) Settings URL
settings_uuid string (uuid) Settings UUID
workload_uuid string (uuid)

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
url string (uri)
uuid string (uuid)
name string
description string
created string (date-time)
modified string (date-time)
runtime_state string
cluster string (uri)
cluster_uuid string (uuid)
cluster_name string
project string (uri)
project_uuid string (uuid)
project_name string
namespace string (uri)
namespace_uuid string (uuid)
namespace_name string
workload string (uri)
workload_uuid string (uuid)
workload_name string
min_replicas integer
max_replicas integer
current_replicas integer
desired_replicas integer
metrics any

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/rancher-hpas/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.rancher_hpas import rancher_hpas_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = rancher_hpas_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: rancher_hpas_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { rancherHpasRetrieve } from 'waldur-js-client';

try {
  const response = await rancherHpasRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
url string (uri)
uuid string (uuid)
name string
description string
created string (date-time)
modified string (date-time)
runtime_state string
cluster string (uri)
cluster_uuid string (uuid)
cluster_name string
project string (uri)
project_uuid string (uuid)
project_name string
namespace string (uri)
namespace_uuid string (uuid)
namespace_name string
workload string (uri)
workload_uuid string (uuid)
workload_name string
min_replicas integer
max_replicas integer
current_replicas integer
desired_replicas integer
metrics any

Create

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/rancher-hpas/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-rancher-hpa" \
  metrics=null

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.rancher_hpa_request import RancherHPARequest # (1)
from waldur_api_client.api.rancher_hpas import rancher_hpas_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = RancherHPARequest(
    name="my-awesome-rancher-hpa",
    metrics=null
)
response = rancher_hpas_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: RancherHPARequest
  2. API Source: rancher_hpas_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { rancherHpasCreate } from 'waldur-js-client';

try {
  const response = await rancherHpasCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "name": "my-awesome-rancher-hpa",
    "metrics": null
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required
name string ✓
description string
workload string (uri)
min_replicas integer
max_replicas integer
metrics any ✓

201 -

Field Type
url string (uri)
uuid string (uuid)
name string
description string
created string (date-time)
modified string (date-time)
runtime_state string
cluster string (uri)
cluster_uuid string (uuid)
cluster_name string
project string (uri)
project_uuid string (uuid)
project_name string
namespace string (uri)
namespace_uuid string (uuid)
namespace_name string
workload string (uri)
workload_uuid string (uuid)
workload_name string
min_replicas integer
max_replicas integer
current_replicas integer
desired_replicas integer
metrics any

Synchronize resource state

Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.

1
2
3
4
http \
  POST \
  https://api.example.com/api/rancher-hpas/a1b2c3d4-e5f6-7890-abcd-ef1234567890/pull/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.rancher_hpas import rancher_hpas_pull # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = rancher_hpas_pull.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: rancher_hpas_pull
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { rancherHpasPull } from 'waldur-js-client';

try {
  const response = await rancherHpasPull({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

202 -

Field Type
detail string

409 -

Field Type
detail string

Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state.

1
2
3
4
http \
  POST \
  https://api.example.com/api/rancher-hpas/a1b2c3d4-e5f6-7890-abcd-ef1234567890/unlink/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.rancher_hpas import rancher_hpas_unlink # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = rancher_hpas_unlink.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: rancher_hpas_unlink
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { rancherHpasUnlink } from 'waldur-js-client';

try {
  const response = await rancherHpasUnlink({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Update

1
2
3
4
5
6
http \
  PUT \
  https://api.example.com/api/rancher-hpas/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-rancher-hpa" \
  metrics=null

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.rancher_hpa_request import RancherHPARequest # (1)
from waldur_api_client.api.rancher_hpas import rancher_hpas_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = RancherHPARequest(
    name="my-awesome-rancher-hpa",
    metrics=null
)
response = rancher_hpas_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: RancherHPARequest
  2. API Source: rancher_hpas_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { rancherHpasUpdate } from 'waldur-js-client';

try {
  const response = await rancherHpasUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-rancher-hpa",
    "metrics": null
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
name string ✓
description string
workload string (uri)
min_replicas integer
max_replicas integer
metrics any ✓

200 -

Field Type
url string (uri)
uuid string (uuid)
name string
description string
created string (date-time)
modified string (date-time)
runtime_state string
cluster string (uri)
cluster_uuid string (uuid)
cluster_name string
project string (uri)
project_uuid string (uuid)
project_name string
namespace string (uri)
namespace_uuid string (uuid)
namespace_name string
workload string (uri)
workload_uuid string (uuid)
workload_name string
min_replicas integer
max_replicas integer
current_replicas integer
desired_replicas integer
metrics any

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/rancher-hpas/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_rancher_hpa_request import PatchedRancherHPARequest # (1)
from waldur_api_client.api.rancher_hpas import rancher_hpas_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedRancherHPARequest()
response = rancher_hpas_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedRancherHPARequest
  2. API Source: rancher_hpas_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { rancherHpasPartialUpdate } from 'waldur-js-client';

try {
  const response = await rancherHpasPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
name string
description string
workload string (uri)
min_replicas integer
max_replicas integer
metrics any

200 -

Field Type
url string (uri)
uuid string (uuid)
name string
description string
created string (date-time)
modified string (date-time)
runtime_state string
cluster string (uri)
cluster_uuid string (uuid)
cluster_name string
project string (uri)
project_uuid string (uuid)
project_name string
namespace string (uri)
namespace_uuid string (uuid)
namespace_name string
workload string (uri)
workload_uuid string (uuid)
workload_name string
min_replicas integer
max_replicas integer
current_replicas integer
desired_replicas integer
metrics any

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/rancher-hpas/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.rancher_hpas import rancher_hpas_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = rancher_hpas_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: rancher_hpas_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { rancherHpasDestroy } from 'waldur-js-client';

try {
  const response = await rancherHpasDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Other Actions

Yaml

1
2
3
4
http \
  GET \
  https://api.example.com/api/rancher-hpas/a1b2c3d4-e5f6-7890-abcd-ef1234567890/yaml/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.rancher_hpas import rancher_hpas_yaml_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = rancher_hpas_yaml_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: rancher_hpas_yaml_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { rancherHpasYamlRetrieve } from 'waldur-js-client';

try {
  const response = await rancherHpasYamlRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
url string (uri)
uuid string (uuid)
name string
description string
created string (date-time)
modified string (date-time)
runtime_state string
cluster string (uri)
cluster_uuid string (uuid)
cluster_name string
project string (uri)
project_uuid string (uuid)
project_name string
namespace string (uri)
namespace_uuid string (uuid)
namespace_name string
workload string (uri)
workload_uuid string (uuid)
workload_name string
min_replicas integer
max_replicas integer
current_replicas integer
desired_replicas integer
metrics any

Mark resource as ERRED

Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.

1
2
3
4
http \
  POST \
  https://api.example.com/api/rancher-hpas/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_erred/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.set_erred_request import SetErredRequest # (1)
from waldur_api_client.api.rancher_hpas import rancher_hpas_set_erred # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = SetErredRequest()
response = rancher_hpas_set_erred.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: SetErredRequest
  2. API Source: rancher_hpas_set_erred
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { rancherHpasSetErred } from 'waldur-js-client';

try {
  const response = await rancherHpasSetErred({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
error_message string
error_traceback string

200 -

Field Type
detail string

Mark resource as OK

Manually transition the resource to OK state and clear error fields. Staff-only operation.

1
2
3
4
http \
  POST \
  https://api.example.com/api/rancher-hpas/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_ok/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.rancher_hpas import rancher_hpas_set_ok # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = rancher_hpas_set_ok.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: rancher_hpas_set_ok
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { rancherHpasSetOk } from 'waldur-js-client';

try {
  const response = await rancherHpasSetOk({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
detail string

Yaml

1
2
3
4
5
6
http \
  PUT \
  https://api.example.com/api/rancher-hpas/a1b2c3d4-e5f6-7890-abcd-ef1234567890/yaml/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-rancher-hpa" \
  metrics=null

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.rancher_hpa_request import RancherHPARequest # (1)
from waldur_api_client.api.rancher_hpas import rancher_hpas_yaml_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = RancherHPARequest(
    name="my-awesome-rancher-hpa",
    metrics=null
)
response = rancher_hpas_yaml_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: RancherHPARequest
  2. API Source: rancher_hpas_yaml_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { rancherHpasYamlUpdate } from 'waldur-js-client';

try {
  const response = await rancherHpasYamlUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-rancher-hpa",
    "metrics": null
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
name string ✓
description string
workload string (uri)
min_replicas integer
max_replicas integer
metrics any ✓

200 -

Field Type
url string (uri)
uuid string (uuid)
name string
description string
created string (date-time)
modified string (date-time)
runtime_state string
cluster string (uri)
cluster_uuid string (uuid)
cluster_name string
project string (uri)
project_uuid string (uuid)
project_name string
namespace string (uri)
namespace_uuid string (uuid)
namespace_name string
workload string (uri)
workload_uuid string (uuid)
workload_name string
min_replicas integer
max_replicas integer
current_replicas integer
desired_replicas integer
metrics any

Rancher Ingresses

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/rancher-ingresses/ List Rancher Ingresses
GET /api/rancher-ingresses/{uuid}/ Retrieve
POST /api/rancher-ingresses/ Create
POST /api/rancher-ingresses/{uuid}/pull/ Synchronize resource state
POST /api/rancher-ingresses/{uuid}/unlink/ Unlink resource
PUT /api/rancher-ingresses/{uuid}/ Update
PATCH /api/rancher-ingresses/{uuid}/ Partial Update
DELETE /api/rancher-ingresses/{uuid}/ Delete
Other Actions
GET /api/rancher-ingresses/{uuid}/yaml/ Yaml
POST /api/rancher-ingresses/{uuid}/set_erred/ Mark resource as ERRED
POST /api/rancher-ingresses/{uuid}/set_ok/ Mark resource as OK
PUT /api/rancher-ingresses/{uuid}/yaml/ Yaml

Core CRUD

List Rancher Ingresses

1
2
3
4
http \
  GET \
  https://api.example.com/api/rancher-ingresses/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.core_states import CoreStates # (1)
from waldur_api_client.models.rancher_ingress_field_enum import RancherIngressFieldEnum # (2)
from waldur_api_client.api.rancher_ingresses import rancher_ingresses_list # (3)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = rancher_ingresses_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: CoreStates
  2. Model Source: RancherIngressFieldEnum
  3. API Source: rancher_ingresses_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { rancherIngressesList } from 'waldur-js-client';

try {
  const response = await rancherIngressesList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
backend_id string Backend ID
can_manage boolean Can manage
cluster_uuid string (uuid)
customer string (uuid) Customer UUID
customer_abbreviation string Customer abbreviation
customer_name string Customer name
customer_native_name string Customer native name
customer_uuid string (uuid) Customer UUID
description string Description
external_ip string External IP
field array
name string Name
name_exact string Name (exact)
namespace_uuid string (uuid)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
project string (uuid) Project UUID
project_name string Project name
project_uuid string (uuid) Project UUID
rancher_project_uuid string (uuid)
service_settings_name string Service settings name
service_settings_uuid string (uuid) Service settings UUID
state array State
uuid string (uuid) UUID

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
runtime_state string
rancher_project string (uri)
rancher_project_name string
namespace string (uri)
namespace_name string
rules any
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/rancher-ingresses/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.rancher_ingress_field_enum import RancherIngressFieldEnum # (1)
from waldur_api_client.api.rancher_ingresses import rancher_ingresses_retrieve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = rancher_ingresses_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. Model Source: RancherIngressFieldEnum
  2. API Source: rancher_ingresses_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { rancherIngressesRetrieve } from 'waldur-js-client';

try {
  const response = await rancherIngressesRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type
field array

200 -

Field Type
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
runtime_state string
rancher_project string (uri)
rancher_project_name string
namespace string (uri)
namespace_name string
rules any
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Create

1
2
3
4
5
6
7
8
http \
  POST \
  https://api.example.com/api/rancher-ingresses/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-rancher-ingress" \
  service_settings="https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  rancher_project="https://api.example.com/api/rancher-project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.rancher_ingress_request import RancherIngressRequest # (1)
from waldur_api_client.api.rancher_ingresses import rancher_ingresses_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = RancherIngressRequest(
    name="my-awesome-rancher-ingress",
    service_settings="https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    rancher_project="https://api.example.com/api/rancher-project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = rancher_ingresses_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: RancherIngressRequest
  2. API Source: rancher_ingresses_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { rancherIngressesCreate } from 'waldur-js-client';

try {
  const response = await rancherIngressesCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "name": "my-awesome-rancher-ingress",
    "service_settings": "https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "project": "https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "rancher_project": "https://api.example.com/api/rancher-project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required
name string ✓
description string
service_settings string (uri) ✓
project string (uri) ✓
error_message string
error_traceback string
backend_id string
runtime_state string
rancher_project string (uri) ✓
namespace string (uri)
rules any

201 -

Field Type
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
runtime_state string
rancher_project string (uri)
rancher_project_name string
namespace string (uri)
namespace_name string
rules any
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Synchronize resource state

Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.

1
2
3
4
http \
  POST \
  https://api.example.com/api/rancher-ingresses/a1b2c3d4-e5f6-7890-abcd-ef1234567890/pull/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.rancher_ingresses import rancher_ingresses_pull # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = rancher_ingresses_pull.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: rancher_ingresses_pull
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { rancherIngressesPull } from 'waldur-js-client';

try {
  const response = await rancherIngressesPull({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

202 -

Field Type
detail string

409 -

Field Type
detail string

Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state.

1
2
3
4
http \
  POST \
  https://api.example.com/api/rancher-ingresses/a1b2c3d4-e5f6-7890-abcd-ef1234567890/unlink/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.rancher_ingresses import rancher_ingresses_unlink # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = rancher_ingresses_unlink.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: rancher_ingresses_unlink
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { rancherIngressesUnlink } from 'waldur-js-client';

try {
  const response = await rancherIngressesUnlink({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Update

1
2
3
4
5
6
7
8
http \
  PUT \
  https://api.example.com/api/rancher-ingresses/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-rancher-ingress" \
  service_settings="https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  rancher_project="https://api.example.com/api/rancher-project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.rancher_ingress_request import RancherIngressRequest # (1)
from waldur_api_client.api.rancher_ingresses import rancher_ingresses_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = RancherIngressRequest(
    name="my-awesome-rancher-ingress",
    service_settings="https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    rancher_project="https://api.example.com/api/rancher-project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = rancher_ingresses_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: RancherIngressRequest
  2. API Source: rancher_ingresses_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
import { rancherIngressesUpdate } from 'waldur-js-client';

try {
  const response = await rancherIngressesUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-rancher-ingress",
    "service_settings": "https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "project": "https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "rancher_project": "https://api.example.com/api/rancher-project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
name string ✓
description string
service_settings string (uri) ✓
project string (uri) ✓
error_message string
error_traceback string
backend_id string
runtime_state string
rancher_project string (uri) ✓
namespace string (uri)
rules any

200 -

Field Type
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
runtime_state string
rancher_project string (uri)
rancher_project_name string
namespace string (uri)
namespace_name string
rules any
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/rancher-ingresses/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_rancher_ingress_request import PatchedRancherIngressRequest # (1)
from waldur_api_client.api.rancher_ingresses import rancher_ingresses_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedRancherIngressRequest()
response = rancher_ingresses_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedRancherIngressRequest
  2. API Source: rancher_ingresses_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { rancherIngressesPartialUpdate } from 'waldur-js-client';

try {
  const response = await rancherIngressesPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
name string
description string
service_settings string (uri)
project string (uri)
error_message string
error_traceback string
backend_id string
runtime_state string
rancher_project string (uri)
namespace string (uri)
rules any

200 -

Field Type
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
runtime_state string
rancher_project string (uri)
rancher_project_name string
namespace string (uri)
namespace_name string
rules any
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/rancher-ingresses/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.rancher_ingresses import rancher_ingresses_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = rancher_ingresses_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: rancher_ingresses_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { rancherIngressesDestroy } from 'waldur-js-client';

try {
  const response = await rancherIngressesDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Other Actions

Yaml

1
2
3
4
http \
  GET \
  https://api.example.com/api/rancher-ingresses/a1b2c3d4-e5f6-7890-abcd-ef1234567890/yaml/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.rancher_ingress_field_enum import RancherIngressFieldEnum # (1)
from waldur_api_client.api.rancher_ingresses import rancher_ingresses_yaml_retrieve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = rancher_ingresses_yaml_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. Model Source: RancherIngressFieldEnum
  2. API Source: rancher_ingresses_yaml_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { rancherIngressesYamlRetrieve } from 'waldur-js-client';

try {
  const response = await rancherIngressesYamlRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type
field array

200 -

Field Type
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
runtime_state string
rancher_project string (uri)
rancher_project_name string
namespace string (uri)
namespace_name string
rules any
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Mark resource as ERRED

Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.

1
2
3
4
http \
  POST \
  https://api.example.com/api/rancher-ingresses/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_erred/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.set_erred_request import SetErredRequest # (1)
from waldur_api_client.api.rancher_ingresses import rancher_ingresses_set_erred # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = SetErredRequest()
response = rancher_ingresses_set_erred.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: SetErredRequest
  2. API Source: rancher_ingresses_set_erred
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { rancherIngressesSetErred } from 'waldur-js-client';

try {
  const response = await rancherIngressesSetErred({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
error_message string
error_traceback string

200 -

Field Type
detail string

Mark resource as OK

Manually transition the resource to OK state and clear error fields. Staff-only operation.

1
2
3
4
http \
  POST \
  https://api.example.com/api/rancher-ingresses/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_ok/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.rancher_ingresses import rancher_ingresses_set_ok # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = rancher_ingresses_set_ok.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: rancher_ingresses_set_ok
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { rancherIngressesSetOk } from 'waldur-js-client';

try {
  const response = await rancherIngressesSetOk({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
detail string

Yaml

1
2
3
4
5
6
7
8
http \
  PUT \
  https://api.example.com/api/rancher-ingresses/a1b2c3d4-e5f6-7890-abcd-ef1234567890/yaml/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-rancher-ingress" \
  service_settings="https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  rancher_project="https://api.example.com/api/rancher-project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.rancher_ingress_request import RancherIngressRequest # (1)
from waldur_api_client.api.rancher_ingresses import rancher_ingresses_yaml_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = RancherIngressRequest(
    name="my-awesome-rancher-ingress",
    service_settings="https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    rancher_project="https://api.example.com/api/rancher-project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = rancher_ingresses_yaml_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: RancherIngressRequest
  2. API Source: rancher_ingresses_yaml_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
import { rancherIngressesYamlUpdate } from 'waldur-js-client';

try {
  const response = await rancherIngressesYamlUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-rancher-ingress",
    "service_settings": "https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "project": "https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "rancher_project": "https://api.example.com/api/rancher-project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
name string ✓
description string
service_settings string (uri) ✓
project string (uri) ✓
error_message string
error_traceback string
backend_id string
runtime_state string
rancher_project string (uri) ✓
namespace string (uri)
rules any

200 -

Field Type
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
runtime_state string
rancher_project string (uri)
rancher_project_name string
namespace string (uri)
namespace_name string
rules any
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Keycloak Groups

Operations Summary

Method Endpoint Description
GET /api/keycloak-groups/ List Keycloak Groups
GET /api/keycloak-groups/{uuid}/ Retrieve

List Keycloak Groups

1
2
3
4
http \
  GET \
  https://api.example.com/api/keycloak-groups/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.keycloak_groups import keycloak_groups_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = keycloak_groups_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: keycloak_groups_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { keycloakGroupsList } from 'waldur-js-client';

try {
  const response = await keycloakGroupsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
role string
scope_type string
scope_uuid string (uuid)

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid)
url string (uri)
name string
backend_id string
scope_type string
scope_uuid string (uuid) UUID of the cluster or project
scope_name string Get the name of the cluster or project
role string (uri)
created string (date-time)
modified string (date-time)

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/keycloak-groups/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.keycloak_groups import keycloak_groups_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = keycloak_groups_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: keycloak_groups_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { keycloakGroupsRetrieve } from 'waldur-js-client';

try {
  const response = await keycloakGroupsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
uuid string (uuid)
url string (uri)
name string
backend_id string
scope_type string
scope_uuid string (uuid) UUID of the cluster or project
scope_name string Get the name of the cluster or project
role string (uri)
created string (date-time)
modified string (date-time)

Keycloak User Group Memberships

Operations Summary

Method Endpoint Description
GET /api/keycloak-user-group-memberships/ List Keycloak User Group Memberships
GET /api/keycloak-user-group-memberships/{uuid}/ Retrieve
POST /api/keycloak-user-group-memberships/ Create
PUT /api/keycloak-user-group-memberships/{uuid}/ Update
PATCH /api/keycloak-user-group-memberships/{uuid}/ Partial Update
DELETE /api/keycloak-user-group-memberships/{uuid}/ Delete

List Keycloak User Group Memberships

1
2
3
4
http \
  GET \
  https://api.example.com/api/keycloak-user-group-memberships/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.keycloak_user_group_membership_state import KeycloakUserGroupMembershipState # (1)
from waldur_api_client.api.keycloak_user_group_memberships import keycloak_user_group_memberships_list # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = keycloak_user_group_memberships_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: KeycloakUserGroupMembershipState
  2. API Source: keycloak_user_group_memberships_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { keycloakUserGroupMembershipsList } from 'waldur-js-client';

try {
  const response = await keycloakUserGroupMembershipsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
email string
first_name string
group_uuid string (uuid)
last_name string
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
role_uuid string (uuid)
scope_type string
scope_uuid string (uuid)
state array
username string

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid)
url string (uri)
username string Keycloak user username
email string (email) User's email for notifications
first_name string
last_name string
group string (uri)
group_name string
group_role string
group_scope_type string
group_scope_name string Get the name of the cluster or project
state any
created string (date-time)
modified string (date-time)
last_checked string (date-time)
error_message string
error_traceback string

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/keycloak-user-group-memberships/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.keycloak_user_group_memberships import keycloak_user_group_memberships_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = keycloak_user_group_memberships_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: keycloak_user_group_memberships_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { keycloakUserGroupMembershipsRetrieve } from 'waldur-js-client';

try {
  const response = await keycloakUserGroupMembershipsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
uuid string (uuid)
url string (uri)
username string Keycloak user username
email string (email) User's email for notifications
first_name string
last_name string
group string (uri)
group_name string
group_role string
group_scope_type string
group_scope_name string Get the name of the cluster or project
state any
created string (date-time)
modified string (date-time)
last_checked string (date-time)
error_message string
error_traceback string

Create

1
2
3
4
5
6
7
8
http \
  POST \
  https://api.example.com/api/keycloak-user-group-memberships/ \
  Authorization:"Token YOUR_API_TOKEN" \
  username="alice" \
  email="alice@example.com" \
  scope_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  role="https://api.example.com/api/role/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.keycloak_user_group_membership_request import KeycloakUserGroupMembershipRequest # (1)
from waldur_api_client.api.keycloak_user_group_memberships import keycloak_user_group_memberships_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = KeycloakUserGroupMembershipRequest(
    username="alice",
    email="alice@example.com",
    scope_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    role="https://api.example.com/api/role/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = keycloak_user_group_memberships_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: KeycloakUserGroupMembershipRequest
  2. API Source: keycloak_user_group_memberships_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { keycloakUserGroupMembershipsCreate } from 'waldur-js-client';

try {
  const response = await keycloakUserGroupMembershipsCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "username": "alice",
    "email": "alice@example.com",
    "scope_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "role": "https://api.example.com/api/role/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
username string ✓ Keycloak user username
email string (email) ✓ User's email for notifications
scope_uuid string (uuid) ✓ UUID of a cluster or a project in Rancher
Constraints: write-only
role string (uri) ✓
Constraints: write-only

201 -

Field Type Description
uuid string (uuid)
url string (uri)
username string Keycloak user username
email string (email) User's email for notifications
first_name string
last_name string
group string (uri)
group_name string
group_role string
group_scope_type string
group_scope_name string Get the name of the cluster or project
state any
created string (date-time)
modified string (date-time)
last_checked string (date-time)
error_message string
error_traceback string

Update

1
2
3
4
5
6
7
8
http \
  PUT \
  https://api.example.com/api/keycloak-user-group-memberships/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  username="alice" \
  email="alice@example.com" \
  scope_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  role="https://api.example.com/api/role/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.keycloak_user_group_membership_request import KeycloakUserGroupMembershipRequest # (1)
from waldur_api_client.api.keycloak_user_group_memberships import keycloak_user_group_memberships_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = KeycloakUserGroupMembershipRequest(
    username="alice",
    email="alice@example.com",
    scope_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    role="https://api.example.com/api/role/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = keycloak_user_group_memberships_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: KeycloakUserGroupMembershipRequest
  2. API Source: keycloak_user_group_memberships_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
import { keycloakUserGroupMembershipsUpdate } from 'waldur-js-client';

try {
  const response = await keycloakUserGroupMembershipsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "username": "alice",
    "email": "alice@example.com",
    "scope_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "role": "https://api.example.com/api/role/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
username string ✓ Keycloak user username
email string (email) ✓ User's email for notifications
scope_uuid string (uuid) ✓ UUID of a cluster or a project in Rancher
Constraints: write-only
role string (uri) ✓
Constraints: write-only

200 -

Field Type Description
uuid string (uuid)
url string (uri)
username string Keycloak user username
email string (email) User's email for notifications
first_name string
last_name string
group string (uri)
group_name string
group_role string
group_scope_type string
group_scope_name string Get the name of the cluster or project
state any
created string (date-time)
modified string (date-time)
last_checked string (date-time)
error_message string
error_traceback string

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/keycloak-user-group-memberships/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_keycloak_user_group_membership_request import PatchedKeycloakUserGroupMembershipRequest # (1)
from waldur_api_client.api.keycloak_user_group_memberships import keycloak_user_group_memberships_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedKeycloakUserGroupMembershipRequest()
response = keycloak_user_group_memberships_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedKeycloakUserGroupMembershipRequest
  2. API Source: keycloak_user_group_memberships_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { keycloakUserGroupMembershipsPartialUpdate } from 'waldur-js-client';

try {
  const response = await keycloakUserGroupMembershipsPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
username string Keycloak user username
email string (email) User's email for notifications
scope_uuid string (uuid) UUID of a cluster or a project in Rancher
Constraints: write-only
role string (uri)
Constraints: write-only

200 -

Field Type Description
uuid string (uuid)
url string (uri)
username string Keycloak user username
email string (email) User's email for notifications
first_name string
last_name string
group string (uri)
group_name string
group_role string
group_scope_type string
group_scope_name string Get the name of the cluster or project
state any
created string (date-time)
modified string (date-time)
last_checked string (date-time)
error_message string
error_traceback string

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/keycloak-user-group-memberships/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.keycloak_user_group_memberships import keycloak_user_group_memberships_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = keycloak_user_group_memberships_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: keycloak_user_group_memberships_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { keycloakUserGroupMembershipsDestroy } from 'waldur-js-client';

try {
  const response = await keycloakUserGroupMembershipsDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Managed Rancher Cluster Resources

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/managed-rancher-cluster-resources/ List Managed Rancher Cluster Resources
GET /api/managed-rancher-cluster-resources/{uuid}/ Retrieve
Other Actions
POST /api/managed-rancher-cluster-resources/{uuid}/add_node/ Add node

Core CRUD

List Managed Rancher Cluster Resources

1
2
3
4
http \
  GET \
  https://api.example.com/api/managed-rancher-cluster-resources/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.resource_field_enum import ResourceFieldEnum # (1)
from waldur_api_client.api.managed_rancher_cluster_resources import managed_rancher_cluster_resources_list # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = managed_rancher_cluster_resources_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: ResourceFieldEnum
  2. API Source: managed_rancher_cluster_resources_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { managedRancherClusterResourcesList } from 'waldur-js-client';

try {
  const response = await managedRancherClusterResourcesList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
field array
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
offering string (uri)
offering_name string
offering_uuid string (uuid)
offering_description string
offering_image string (uri)
offering_thumbnail string (uri)
offering_type string
offering_shared boolean Accessible to all customers.
offering_billable boolean Purchase and usage is invoiced.
offering_plugin_options any Public data used by specific plugin, such as storage mode for OpenStack.
provider_name string
provider_uuid string (uuid)
provider_slug string
category_title string
category_uuid string (uuid)
category_icon string (uri)
plan string (uri)
plan_unit any
plan_name string
plan_uuid string (uuid)
plan_description string
attributes object (free-form)
limits object (free-form)
uuid string (uuid)
created string (date-time)
modified string (date-time)
url string (uri)
scope string
description string
state any
resource_uuid string (uuid)
backend_id string
effective_id string
resource_type string
project string (uri)
project_uuid string (uuid)
project_name string
project_description string
project_end_date string (date) The date is inclusive. Once reached, all project resource will be scheduled for termination.
project_end_date_requested_by string (uri)
customer_uuid string (uuid)
customer_name string
offering_slug string
parent_offering_uuid string (uuid)
parent_offering_name string
parent_offering_slug string
offering_backend_id string
parent_uuid string (uuid)
parent_name string
backend_metadata any
is_usage_based boolean Returns True if the resource has usage-based components that track variable consumption.
is_limit_based boolean Returns True if the resource has limit-based components with user-adjustable quotas.
name string
slug string URL-friendly identifier. Only editable by staff users.
current_usages object (free-form) Dictionary mapping component types to their latest reported usage amounts.
can_terminate boolean
report array of objects
report.header string Section header text
report.body string Section body content
end_date string (date) The date is inclusive. Once reached, a resource will be scheduled for termination.
end_date_requested_by string (uri)
username string
limit_usage object (free-form) Dictionary mapping limit-based component types to their consumed usage. For monthly periods, maps from current_usages; for longer periods, aggregates historical usage.
downscaled boolean
restrict_member_access boolean
paused boolean
endpoints array of objects
endpoints.uuid string (uuid)
endpoints.name string
endpoints.url string URL of the access endpoint
error_message string
error_traceback string
options any
available_actions array of strings
last_sync string (date-time)
order_in_progress any
creation_order any
service_settings_uuid string (uuid)
project_slug string
customer_slug string
user_requires_reconsent boolean Check if the current user needs to re-consent for this resource's offering.
renewal_date object (free-form)
offering_state any
offering_components array of objects
offering_components.uuid string (uuid)
offering_components.billing_type string
Enum: fixed, usage, limit, one, few
offering_components.type string Unique internal name of the measured unit, for example floating_ip.
offering_components.name string Display name for the measured unit, for example, Floating IP.
offering_components.description string
offering_components.measured_unit string Unit of measurement, for example, GB.
offering_components.unit_factor integer The conversion factor from backend units to measured_unit
offering_components.limit_period any
offering_components.limit_amount integer
offering_components.article_code string
offering_components.max_value integer
offering_components.min_value integer
offering_components.max_available_limit integer
offering_components.is_boolean boolean
offering_components.default_limit integer
offering_components.factor integer
offering_components.is_builtin boolean
offering_components.is_prepaid boolean
offering_components.overage_component string (uuid)
offering_components.min_prepaid_duration integer
offering_components.max_prepaid_duration integer

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/managed-rancher-cluster-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.resource_field_enum import ResourceFieldEnum # (1)
from waldur_api_client.api.managed_rancher_cluster_resources import managed_rancher_cluster_resources_retrieve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = managed_rancher_cluster_resources_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. Model Source: ResourceFieldEnum
  2. API Source: managed_rancher_cluster_resources_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { managedRancherClusterResourcesRetrieve } from 'waldur-js-client';

try {
  const response = await managedRancherClusterResourcesRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type
field array

200 -

Field Type Description
offering string (uri)
offering_name string
offering_uuid string (uuid)
offering_description string
offering_image string (uri)
offering_thumbnail string (uri)
offering_type string
offering_shared boolean Accessible to all customers.
offering_billable boolean Purchase and usage is invoiced.
offering_plugin_options any Public data used by specific plugin, such as storage mode for OpenStack.
provider_name string
provider_uuid string (uuid)
provider_slug string
category_title string
category_uuid string (uuid)
category_icon string (uri)
plan string (uri)
plan_unit any
plan_name string
plan_uuid string (uuid)
plan_description string
attributes object (free-form)
limits object (free-form)
uuid string (uuid)
created string (date-time)
modified string (date-time)
url string (uri)
scope string
description string
state any
resource_uuid string (uuid)
backend_id string
effective_id string
resource_type string
project string (uri)
project_uuid string (uuid)
project_name string
project_description string
project_end_date string (date) The date is inclusive. Once reached, all project resource will be scheduled for termination.
project_end_date_requested_by string (uri)
customer_uuid string (uuid)
customer_name string
offering_slug string
parent_offering_uuid string (uuid)
parent_offering_name string
parent_offering_slug string
offering_backend_id string
parent_uuid string (uuid)
parent_name string
backend_metadata any
is_usage_based boolean Returns True if the resource has usage-based components that track variable consumption.
is_limit_based boolean Returns True if the resource has limit-based components with user-adjustable quotas.
name string
slug string URL-friendly identifier. Only editable by staff users.
current_usages object (free-form) Dictionary mapping component types to their latest reported usage amounts.
can_terminate boolean
report array of objects
report.header string Section header text
report.body string Section body content
end_date string (date) The date is inclusive. Once reached, a resource will be scheduled for termination.
end_date_requested_by string (uri)
username string
limit_usage object (free-form) Dictionary mapping limit-based component types to their consumed usage. For monthly periods, maps from current_usages; for longer periods, aggregates historical usage.
downscaled boolean
restrict_member_access boolean
paused boolean
endpoints array of objects
endpoints.uuid string (uuid)
endpoints.name string
endpoints.url string URL of the access endpoint
error_message string
error_traceback string
options any
available_actions array of strings
last_sync string (date-time)
order_in_progress any
creation_order any
service_settings_uuid string (uuid)
project_slug string
customer_slug string
user_requires_reconsent boolean Check if the current user needs to re-consent for this resource's offering.
renewal_date object (free-form)
offering_state any
offering_components array of objects
offering_components.uuid string (uuid)
offering_components.billing_type string
Enum: fixed, usage, limit, one, few
offering_components.type string Unique internal name of the measured unit, for example floating_ip.
offering_components.name string Display name for the measured unit, for example, Floating IP.
offering_components.description string
offering_components.measured_unit string Unit of measurement, for example, GB.
offering_components.unit_factor integer The conversion factor from backend units to measured_unit
offering_components.limit_period any
offering_components.limit_amount integer
offering_components.article_code string
offering_components.max_value integer
offering_components.min_value integer
offering_components.max_available_limit integer
offering_components.is_boolean boolean
offering_components.default_limit integer
offering_components.factor integer
offering_components.is_builtin boolean
offering_components.is_prepaid boolean
offering_components.overage_component string (uuid)
offering_components.min_prepaid_duration integer
offering_components.max_prepaid_duration integer

Other Actions

Add node

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/managed-rancher-cluster-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/add_node/ \
  Authorization:"Token YOUR_API_TOKEN" \
  role="agent" \
  subnet="https://api.example.com/api/subnet/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.managed_rancher_create_node_request import ManagedRancherCreateNodeRequest # (1)
from waldur_api_client.api.managed_rancher_cluster_resources import managed_rancher_cluster_resources_add_node # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ManagedRancherCreateNodeRequest(
    role="agent",
    subnet="https://api.example.com/api/subnet/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = managed_rancher_cluster_resources_add_node.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ManagedRancherCreateNodeRequest
  2. API Source: managed_rancher_cluster_resources_add_node
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { managedRancherClusterResourcesAddNode } from 'waldur-js-client';

try {
  const response = await managedRancherClusterResourcesAddNode({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "role": "agent",
    "subnet": "https://api.example.com/api/subnet/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
role string ✓
system_volume_size integer
system_volume_type string (uri)
memory integer
cpu integer
subnet string (uri) ✓
flavor string (uri)
data_volumes array of objects
data_volumes.size integer ✓
data_volumes.volume_type string (uri)
data_volumes.filesystem string
data_volumes.mount_point string ✓
ssh_public_key string (uri)
tenant string (uri)

200 -

Field Type Description
uuid string (uuid)
url string (uri)
created string (date-time)
modified string (date-time)
name string
backend_id string
project_uuid string (uuid)
service_settings_name string
service_settings_uuid string (uuid)
resource_type string
state any
cluster string (uri)
cluster_name string
cluster_uuid string (uuid)
instance string
instance_name string
instance_uuid string (uuid)
instance_marketplace_uuid string (uuid)
role string
Enum: agent, server
k8s_version string
docker_version string
cpu_allocated number (double)
cpu_total integer
ram_allocated integer Allocated RAM in Mi.
ram_total integer Total RAM in Mi.
pods_allocated integer
pods_total integer
labels any
annotations any
runtime_state string

Rancher Namespaces

Operations Summary

Method Endpoint Description
GET /api/rancher-namespaces/ List Rancher Namespaces
GET /api/rancher-namespaces/{uuid}/ Retrieve

List Rancher Namespaces

1
2
3
4
http \
  GET \
  https://api.example.com/api/rancher-namespaces/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.rancher_namespace_o_enum import RancherNamespaceOEnum # (1)
from waldur_api_client.api.rancher_namespaces import rancher_namespaces_list # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = rancher_namespaces_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: RancherNamespaceOEnum
  2. API Source: rancher_namespaces_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { rancherNamespacesList } from 'waldur-js-client';

try {
  const response = await rancherNamespacesList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
cluster_uuid string (uuid)
name string Name
name_exact string Name (exact)
o array Ordering
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
project_uuid string (uuid)
settings string (uri) Settings URL
settings_uuid string (uuid) Settings UUID

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
url string (uri)
uuid string (uuid)
name string
created string (date-time)
modified string (date-time)
runtime_state string
project string (uri)

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/rancher-namespaces/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.rancher_namespaces import rancher_namespaces_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = rancher_namespaces_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: rancher_namespaces_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { rancherNamespacesRetrieve } from 'waldur-js-client';

try {
  const response = await rancherNamespacesRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
url string (uri)
uuid string (uuid)
name string
created string (date-time)
modified string (date-time)
runtime_state string
project string (uri)

Rancher Nodes

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/rancher-nodes/ List Rancher Nodes
GET /api/rancher-nodes/{uuid}/ Retrieve
POST /api/rancher-nodes/ Create
POST /api/rancher-nodes/{uuid}/pull/ Synchronize resource state
POST /api/rancher-nodes/{uuid}/unlink/ Unlink resource
POST /api/rancher-nodes/{uuid}/unlink_openstack/ Unlinks node from OpenStack instance
DELETE /api/rancher-nodes/{uuid}/ Delete
Other Actions
GET /api/rancher-nodes/{uuid}/console_log/ Returns console log for the node
GET /api/rancher-nodes/{uuid}/console/ Returns console URL for the node
POST /api/rancher-nodes/{uuid}/link_openstack/ Links node to OpenStack instance
POST /api/rancher-nodes/{uuid}/set_erred/ Mark resource as ERRED
POST /api/rancher-nodes/{uuid}/set_ok/ Mark resource as OK

Core CRUD

List Rancher Nodes

1
2
3
4
http \
  GET \
  https://api.example.com/api/rancher-nodes/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.rancher_nodes import rancher_nodes_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = rancher_nodes_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: rancher_nodes_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { rancherNodesList } from 'waldur-js-client';

try {
  const response = await rancherNodesList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
cluster_uuid string (uuid)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid)
url string (uri)
created string (date-time)
modified string (date-time)
name string
backend_id string
project_uuid string (uuid)
service_settings_name string
service_settings_uuid string (uuid)
resource_type string
state any
cluster string (uri)
cluster_name string
cluster_uuid string (uuid)
instance string
instance_name string
instance_uuid string (uuid)
instance_marketplace_uuid string (uuid)
role string
Enum: agent, server
k8s_version string
docker_version string
cpu_allocated number (double)
cpu_total integer
ram_allocated integer Allocated RAM in Mi.
ram_total integer Total RAM in Mi.
pods_allocated integer
pods_total integer
labels any
annotations any
runtime_state string

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/rancher-nodes/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.rancher_nodes import rancher_nodes_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = rancher_nodes_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: rancher_nodes_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { rancherNodesRetrieve } from 'waldur-js-client';

try {
  const response = await rancherNodesRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
uuid string (uuid)
url string (uri)
created string (date-time)
modified string (date-time)
name string
backend_id string
project_uuid string (uuid)
service_settings_name string
service_settings_uuid string (uuid)
resource_type string
state any
cluster string (uri)
cluster_name string
cluster_uuid string (uuid)
instance string
instance_name string
instance_uuid string (uuid)
instance_marketplace_uuid string (uuid)
role string
Enum: agent, server
k8s_version string
docker_version string
cpu_allocated number (double)
cpu_total integer
ram_allocated integer Allocated RAM in Mi.
ram_total integer Total RAM in Mi.
pods_allocated integer
pods_total integer
labels any
annotations any
runtime_state string

Create

1
2
3
4
5
6
7
http \
  POST \
  https://api.example.com/api/rancher-nodes/ \
  Authorization:"Token YOUR_API_TOKEN" \
  cluster="https://api.example.com/api/cluster/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  role="agent" \
  subnet="https://api.example.com/api/subnet/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.rancher_create_node_request import RancherCreateNodeRequest # (1)
from waldur_api_client.api.rancher_nodes import rancher_nodes_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = RancherCreateNodeRequest(
    cluster="https://api.example.com/api/cluster/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    role="agent",
    subnet="https://api.example.com/api/subnet/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = rancher_nodes_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: RancherCreateNodeRequest
  2. API Source: rancher_nodes_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
import { rancherNodesCreate } from 'waldur-js-client';

try {
  const response = await rancherNodesCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "cluster": "https://api.example.com/api/cluster/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "role": "agent",
    "subnet": "https://api.example.com/api/subnet/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required
cluster string (uri) ✓
role string ✓
system_volume_size integer
system_volume_type string (uri)
memory integer
cpu integer
subnet string (uri) ✓
flavor string (uri)
data_volumes array of objects
data_volumes.size integer ✓
data_volumes.volume_type string (uri)
data_volumes.filesystem string
data_volumes.mount_point string ✓
ssh_public_key string (uri)
tenant string (uri)

201 -

Field Type
cluster string (uri)
role string
uuid string (uuid)

Synchronize resource state

Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.

1
2
3
4
http \
  POST \
  https://api.example.com/api/rancher-nodes/a1b2c3d4-e5f6-7890-abcd-ef1234567890/pull/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.rancher_nodes import rancher_nodes_pull # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = rancher_nodes_pull.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: rancher_nodes_pull
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { rancherNodesPull } from 'waldur-js-client';

try {
  const response = await rancherNodesPull({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

202 -

Field Type
detail string

409 -

Field Type
detail string

Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state.

1
2
3
4
http \
  POST \
  https://api.example.com/api/rancher-nodes/a1b2c3d4-e5f6-7890-abcd-ef1234567890/unlink/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.rancher_nodes import rancher_nodes_unlink # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = rancher_nodes_unlink.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: rancher_nodes_unlink
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { rancherNodesUnlink } from 'waldur-js-client';

try {
  const response = await rancherNodesUnlink({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Unlinks node from OpenStack instance.

1
2
3
4
http \
  POST \
  https://api.example.com/api/rancher-nodes/a1b2c3d4-e5f6-7890-abcd-ef1234567890/unlink_openstack/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.rancher_nodes import rancher_nodes_unlink_openstack # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = rancher_nodes_unlink_openstack.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: rancher_nodes_unlink_openstack
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { rancherNodesUnlinkOpenstack } from 'waldur-js-client';

try {
  const response = await rancherNodesUnlinkOpenstack({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 - No response body

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/rancher-nodes/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.rancher_nodes import rancher_nodes_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = rancher_nodes_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: rancher_nodes_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { rancherNodesDestroy } from 'waldur-js-client';

try {
  const response = await rancherNodesDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Other Actions

Returns console log for the node

Returns console log for the node.

1
2
3
4
http \
  GET \
  https://api.example.com/api/rancher-nodes/a1b2c3d4-e5f6-7890-abcd-ef1234567890/console_log/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.rancher_nodes import rancher_nodes_console_log_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = rancher_nodes_console_log_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: rancher_nodes_console_log_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { rancherNodesConsoleLogRetrieve } from 'waldur-js-client';

try {
  const response = await rancherNodesConsoleLogRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type
length integer

200 -

404 - No response body

Returns console URL for the node

Returns console URL for the node.

1
2
3
4
http \
  GET \
  https://api.example.com/api/rancher-nodes/a1b2c3d4-e5f6-7890-abcd-ef1234567890/console/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.rancher_nodes import rancher_nodes_console_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = rancher_nodes_console_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: rancher_nodes_console_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { rancherNodesConsoleRetrieve } from 'waldur-js-client';

try {
  const response = await rancherNodesConsoleRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
url string (uri)

Links node to OpenStack instance.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/rancher-nodes/a1b2c3d4-e5f6-7890-abcd-ef1234567890/link_openstack/ \
  Authorization:"Token YOUR_API_TOKEN" \
  instance="https://api.example.com/api/instance/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.link_openstack_request import LinkOpenstackRequest # (1)
from waldur_api_client.api.rancher_nodes import rancher_nodes_link_openstack # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = LinkOpenstackRequest(
    instance="https://api.example.com/api/instance/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = rancher_nodes_link_openstack.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: LinkOpenstackRequest
  2. API Source: rancher_nodes_link_openstack
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { rancherNodesLinkOpenstack } from 'waldur-js-client';

try {
  const response = await rancherNodesLinkOpenstack({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "instance": "https://api.example.com/api/instance/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
instance string (uri) ✓

200 - No response body

Mark resource as ERRED

Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.

1
2
3
4
http \
  POST \
  https://api.example.com/api/rancher-nodes/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_erred/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.set_erred_request import SetErredRequest # (1)
from waldur_api_client.api.rancher_nodes import rancher_nodes_set_erred # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = SetErredRequest()
response = rancher_nodes_set_erred.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: SetErredRequest
  2. API Source: rancher_nodes_set_erred
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { rancherNodesSetErred } from 'waldur-js-client';

try {
  const response = await rancherNodesSetErred({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
error_message string
error_traceback string

200 -

Field Type
detail string

Mark resource as OK

Manually transition the resource to OK state and clear error fields. Staff-only operation.

1
2
3
4
http \
  POST \
  https://api.example.com/api/rancher-nodes/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_ok/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.rancher_nodes import rancher_nodes_set_ok # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = rancher_nodes_set_ok.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: rancher_nodes_set_ok
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { rancherNodesSetOk } from 'waldur-js-client';

try {
  const response = await rancherNodesSetOk({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
detail string

Rancher Projects

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/rancher-projects/ List Rancher Projects
GET /api/rancher-projects/{uuid}/ Retrieve
Other Actions
GET /api/rancher-projects/{uuid}/secrets/ Returns project's secrets

Core CRUD

List Rancher Projects

1
2
3
4
http \
  GET \
  https://api.example.com/api/rancher-projects/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.rancher_projects import rancher_projects_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = rancher_projects_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: rancher_projects_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { rancherProjectsList } from 'waldur-js-client';

try {
  const response = await rancherProjectsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
cluster_uuid string (uuid)
name string Name
name_exact string Name (exact)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
settings string (uri) Settings URL
settings_uuid string (uuid) Settings UUID

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
url string (uri)
uuid string (uuid)
name string
description string
created string (date-time)
modified string (date-time)
runtime_state string
cluster string (uri)
namespaces array of objects
namespaces.url string (uri)
namespaces.uuid string (uuid)
namespaces.name string

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/rancher-projects/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.rancher_projects import rancher_projects_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = rancher_projects_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: rancher_projects_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { rancherProjectsRetrieve } from 'waldur-js-client';

try {
  const response = await rancherProjectsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
url string (uri)
uuid string (uuid)
name string
description string
created string (date-time)
modified string (date-time)
runtime_state string
cluster string (uri)
namespaces array of objects
namespaces.url string (uri)
namespaces.uuid string (uuid)
namespaces.name string

Other Actions

Returns project's secrets

Returns project's secrets.

1
2
3
4
http \
  GET \
  https://api.example.com/api/rancher-projects/a1b2c3d4-e5f6-7890-abcd-ef1234567890/secrets/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.rancher_projects import rancher_projects_secrets_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = rancher_projects_secrets_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: rancher_projects_secrets_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { rancherProjectsSecretsRetrieve } from 'waldur-js-client';

try {
  const response = await rancherProjectsSecretsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
url string (uri)
uuid string (uuid)
name string
description string
created string (date-time)
modified string (date-time)
runtime_state string
cluster string (uri)
namespaces array of objects
namespaces.url string (uri)
namespaces.uuid string (uuid)
namespaces.name string

Rancher Role Templates

Operations Summary

Method Endpoint Description
GET /api/rancher-role-templates/ List Rancher Role Templates
GET /api/rancher-role-templates/{uuid}/ Retrieve

List Rancher Role Templates

1
2
3
4
http \
  GET \
  https://api.example.com/api/rancher-role-templates/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.role_template_o_enum import RoleTemplateOEnum # (1)
from waldur_api_client.api.rancher_role_templates import rancher_role_templates_list # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = rancher_role_templates_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: RoleTemplateOEnum
  2. API Source: rancher_role_templates_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { rancherRoleTemplatesList } from 'waldur-js-client';

try {
  const response = await rancherRoleTemplatesList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
name string
o array Ordering
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
scope_type string
settings_uuid string (uuid)

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
name string Role internal name
scope_type any
display_name string Role public name
settings string (uri)

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/rancher-role-templates/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.rancher_role_templates import rancher_role_templates_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = rancher_role_templates_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: rancher_role_templates_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { rancherRoleTemplatesRetrieve } from 'waldur-js-client';

try {
  const response = await rancherRoleTemplatesRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string Role internal name
scope_type any
display_name string Role public name
settings string (uri)

Rancher Services

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/rancher-services/ List Rancher Services
GET /api/rancher-services/{uuid}/ Retrieve
POST /api/rancher-services/ Create
POST /api/rancher-services/{uuid}/pull/ Synchronize resource state
POST /api/rancher-services/{uuid}/unlink/ Unlink resource
PUT /api/rancher-services/{uuid}/ Update
PATCH /api/rancher-services/{uuid}/ Partial Update
DELETE /api/rancher-services/{uuid}/ Delete
Other Actions
GET /api/rancher-services/{uuid}/yaml/ Yaml
POST /api/rancher-services/{uuid}/set_erred/ Mark resource as ERRED
POST /api/rancher-services/{uuid}/set_ok/ Mark resource as OK
PUT /api/rancher-services/{uuid}/yaml/ Yaml

Core CRUD

List Rancher Services

1
2
3
4
http \
  GET \
  https://api.example.com/api/rancher-services/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.core_states import CoreStates # (1)
from waldur_api_client.models.rancher_service_field_enum import RancherServiceFieldEnum # (2)
from waldur_api_client.api.rancher_services import rancher_services_list # (3)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = rancher_services_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: CoreStates
  2. Model Source: RancherServiceFieldEnum
  3. API Source: rancher_services_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { rancherServicesList } from 'waldur-js-client';

try {
  const response = await rancherServicesList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
backend_id string Backend ID
can_manage boolean Can manage
cluster_uuid string (uuid)
customer string (uuid) Customer UUID
customer_abbreviation string Customer abbreviation
customer_name string Customer name
customer_native_name string Customer native name
customer_uuid string (uuid) Customer UUID
description string Description
external_ip string External IP
field array
name string Name
name_exact string Name (exact)
namespace_uuid string (uuid)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
project string (uuid) Project UUID
project_name string Project name
project_uuid string (uuid) Project UUID
rancher_project_uuid string (uuid)
service_settings_name string Service settings name
service_settings_uuid string (uuid) Service settings UUID
state array State
uuid string (uuid) UUID

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
runtime_state string
namespace string (uri)
namespace_name string
cluster_ip any An IPv4 or IPv6 address.
selector any
target_workloads array of objects
target_workloads.uuid string (uuid)
target_workloads.url string (uri)
target_workloads.name string
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/rancher-services/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.rancher_service_field_enum import RancherServiceFieldEnum # (1)
from waldur_api_client.api.rancher_services import rancher_services_retrieve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = rancher_services_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. Model Source: RancherServiceFieldEnum
  2. API Source: rancher_services_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { rancherServicesRetrieve } from 'waldur-js-client';

try {
  const response = await rancherServicesRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type
field array

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
runtime_state string
namespace string (uri)
namespace_name string
cluster_ip any An IPv4 or IPv6 address.
selector any
target_workloads array of objects
target_workloads.uuid string (uuid)
target_workloads.url string (uri)
target_workloads.name string
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Create

1
2
3
4
5
6
7
http \
  POST \
  https://api.example.com/api/rancher-services/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-rancher-service" \
  service_settings="https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.rancher_service_create_request import RancherServiceCreateRequest # (1)
from waldur_api_client.api.rancher_services import rancher_services_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = RancherServiceCreateRequest(
    name="my-awesome-rancher-service",
    service_settings="https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = rancher_services_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: RancherServiceCreateRequest
  2. API Source: rancher_services_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
import { rancherServicesCreate } from 'waldur-js-client';

try {
  const response = await rancherServicesCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "name": "my-awesome-rancher-service",
    "service_settings": "https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "project": "https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
name string ✓
description string
service_settings string (uri) ✓
project string (uri) ✓
error_message string
error_traceback string
backend_id string
runtime_state string
namespace string (uri)
cluster_ip any An IPv4 or IPv6 address.
selector any
target_workloads array of objects
target_workloads.url string (uri) ✓

201 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
runtime_state string
namespace string (uri)
namespace_name string
cluster_ip any An IPv4 or IPv6 address.
selector any
target_workloads array of objects
target_workloads.url string (uri)
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Synchronize resource state

Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.

1
2
3
4
http \
  POST \
  https://api.example.com/api/rancher-services/a1b2c3d4-e5f6-7890-abcd-ef1234567890/pull/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.rancher_services import rancher_services_pull # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = rancher_services_pull.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: rancher_services_pull
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { rancherServicesPull } from 'waldur-js-client';

try {
  const response = await rancherServicesPull({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

202 -

Field Type
detail string

409 -

Field Type
detail string

Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state.

1
2
3
4
http \
  POST \
  https://api.example.com/api/rancher-services/a1b2c3d4-e5f6-7890-abcd-ef1234567890/unlink/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.rancher_services import rancher_services_unlink # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = rancher_services_unlink.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: rancher_services_unlink
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { rancherServicesUnlink } from 'waldur-js-client';

try {
  const response = await rancherServicesUnlink({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Update

1
2
3
4
5
6
7
8
http \
  PUT \
  https://api.example.com/api/rancher-services/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-rancher-service" \
  service_settings="https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  target_workloads:='[]'

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.rancher_service_request import RancherServiceRequest # (1)
from waldur_api_client.api.rancher_services import rancher_services_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = RancherServiceRequest(
    name="my-awesome-rancher-service",
    service_settings="https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    target_workloads=[]
)
response = rancher_services_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: RancherServiceRequest
  2. API Source: rancher_services_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
import { rancherServicesUpdate } from 'waldur-js-client';

try {
  const response = await rancherServicesUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-rancher-service",
    "service_settings": "https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "project": "https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "target_workloads": []
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
name string ✓
description string
service_settings string (uri) ✓
project string (uri) ✓
error_message string
error_traceback string
backend_id string
runtime_state string
namespace string (uri)
cluster_ip any An IPv4 or IPv6 address.
selector any
target_workloads array of objects ✓
target_workloads.name string ✓

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
runtime_state string
namespace string (uri)
namespace_name string
cluster_ip any An IPv4 or IPv6 address.
selector any
target_workloads array of objects
target_workloads.uuid string (uuid)
target_workloads.url string (uri)
target_workloads.name string
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/rancher-services/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_rancher_service_request import PatchedRancherServiceRequest # (1)
from waldur_api_client.api.rancher_services import rancher_services_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedRancherServiceRequest()
response = rancher_services_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedRancherServiceRequest
  2. API Source: rancher_services_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { rancherServicesPartialUpdate } from 'waldur-js-client';

try {
  const response = await rancherServicesPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
name string
description string
service_settings string (uri)
project string (uri)
error_message string
error_traceback string
backend_id string
runtime_state string
namespace string (uri)
cluster_ip any An IPv4 or IPv6 address.
selector any
target_workloads array of objects
target_workloads.name string ✓

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
runtime_state string
namespace string (uri)
namespace_name string
cluster_ip any An IPv4 or IPv6 address.
selector any
target_workloads array of objects
target_workloads.uuid string (uuid)
target_workloads.url string (uri)
target_workloads.name string
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/rancher-services/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.rancher_services import rancher_services_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = rancher_services_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: rancher_services_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { rancherServicesDestroy } from 'waldur-js-client';

try {
  const response = await rancherServicesDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Other Actions

Yaml

1
2
3
4
http \
  GET \
  https://api.example.com/api/rancher-services/a1b2c3d4-e5f6-7890-abcd-ef1234567890/yaml/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.rancher_service_field_enum import RancherServiceFieldEnum # (1)
from waldur_api_client.api.rancher_services import rancher_services_yaml_retrieve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = rancher_services_yaml_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. Model Source: RancherServiceFieldEnum
  2. API Source: rancher_services_yaml_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { rancherServicesYamlRetrieve } from 'waldur-js-client';

try {
  const response = await rancherServicesYamlRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type
field array

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
runtime_state string
namespace string (uri)
namespace_name string
cluster_ip any An IPv4 or IPv6 address.
selector any
target_workloads array of objects
target_workloads.uuid string (uuid)
target_workloads.url string (uri)
target_workloads.name string
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Mark resource as ERRED

Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.

1
2
3
4
http \
  POST \
  https://api.example.com/api/rancher-services/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_erred/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.set_erred_request import SetErredRequest # (1)
from waldur_api_client.api.rancher_services import rancher_services_set_erred # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = SetErredRequest()
response = rancher_services_set_erred.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: SetErredRequest
  2. API Source: rancher_services_set_erred
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { rancherServicesSetErred } from 'waldur-js-client';

try {
  const response = await rancherServicesSetErred({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
error_message string
error_traceback string

200 -

Field Type
detail string

Mark resource as OK

Manually transition the resource to OK state and clear error fields. Staff-only operation.

1
2
3
4
http \
  POST \
  https://api.example.com/api/rancher-services/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_ok/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.rancher_services import rancher_services_set_ok # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = rancher_services_set_ok.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: rancher_services_set_ok
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { rancherServicesSetOk } from 'waldur-js-client';

try {
  const response = await rancherServicesSetOk({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
detail string

Yaml

1
2
3
4
5
6
7
8
http \
  PUT \
  https://api.example.com/api/rancher-services/a1b2c3d4-e5f6-7890-abcd-ef1234567890/yaml/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-rancher-service" \
  service_settings="https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  target_workloads:='[]'

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.rancher_service_request import RancherServiceRequest # (1)
from waldur_api_client.api.rancher_services import rancher_services_yaml_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = RancherServiceRequest(
    name="my-awesome-rancher-service",
    service_settings="https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    target_workloads=[]
)
response = rancher_services_yaml_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: RancherServiceRequest
  2. API Source: rancher_services_yaml_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
import { rancherServicesYamlUpdate } from 'waldur-js-client';

try {
  const response = await rancherServicesYamlUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-rancher-service",
    "service_settings": "https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "project": "https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "target_workloads": []
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
name string ✓
description string
service_settings string (uri) ✓
project string (uri) ✓
error_message string
error_traceback string
backend_id string
runtime_state string
namespace string (uri)
cluster_ip any An IPv4 or IPv6 address.
selector any
target_workloads array of objects ✓
target_workloads.name string ✓

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
runtime_state string
namespace string (uri)
namespace_name string
cluster_ip any An IPv4 or IPv6 address.
selector any
target_workloads array of objects
target_workloads.uuid string (uuid)
target_workloads.url string (uri)
target_workloads.name string
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Rancher Template Versions

Operations Summary

Method Endpoint Description
GET /api/rancher-template-versions/{template_uuid}/{version}/ Retrieve

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/rancher-template-versions/a1b2c3d4-e5f6-7890-abcd-ef1234567890/string-value/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.rancher_template_versions import rancher_template_versions_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = rancher_template_versions_retrieve.sync(
    template_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    version="string-value",
    client=client
)

print(response)
  1. API Source: rancher_template_versions_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { rancherTemplateVersionsRetrieve } from 'waldur-js-client';

try {
  const response = await rancherTemplateVersionsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "template_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "version": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
template_uuid string ✓
version string ✓

200 -

Field Type
readme string
app_readme string
questions array of objects
questions.label string
questions.description string
questions.variable string
questions.required boolean
questions.validate_ any
questions.type string
questions.default string
questions.group string
questions.showIf string
questions.subquestions array of objects
questions.subquestions.label string
questions.subquestions.description string
questions.subquestions.variable string
questions.subquestions.required boolean
questions.subquestions.validate_ any
questions.subquestions.type string
questions.subquestions.default string
questions.subquestions.group string
questions.subquestions.showIf string
questions.showSubquestionIf string

Rancher Templates

Operations Summary

Method Endpoint Description
GET /api/rancher-templates/ List Rancher Templates
GET /api/rancher-templates/{uuid}/ Retrieve

List Rancher Templates

1
2
3
4
http \
  GET \
  https://api.example.com/api/rancher-templates/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.rancher_template_o_enum import RancherTemplateOEnum # (1)
from waldur_api_client.api.rancher_templates import rancher_templates_list # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = rancher_templates_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: RancherTemplateOEnum
  2. API Source: rancher_templates_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { rancherTemplatesList } from 'waldur-js-client';

try {
  const response = await rancherTemplatesList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
catalog_uuid string (uuid)
cluster_uuid string (uuid)
name string Name
name_exact string Name (exact)
o array Ordering
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
project_uuid string (uuid)
settings string (uri) Settings URL
settings_uuid string (uuid) Settings UUID

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
url string (uri)
uuid string (uuid)
name string
description string
created string (date-time)
modified string (date-time)
runtime_state string
catalog string (uri)
cluster string (uri)
project string (uri)
icon string (uri)
project_url string (uri)
default_version string
catalog_name string
versions array of strings

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/rancher-templates/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.rancher_templates import rancher_templates_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = rancher_templates_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: rancher_templates_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { rancherTemplatesRetrieve } from 'waldur-js-client';

try {
  const response = await rancherTemplatesRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
url string (uri)
uuid string (uuid)
name string
description string
created string (date-time)
modified string (date-time)
runtime_state string
catalog string (uri)
cluster string (uri)
project string (uri)
icon string (uri)
project_url string (uri)
default_version string
catalog_name string
versions array of strings

Rancher Users

Operations Summary

Method Endpoint Description
GET /api/rancher-users/ List Rancher Users
GET /api/rancher-users/{uuid}/ Retrieve

List Rancher Users

1
2
3
4
http \
  GET \
  https://api.example.com/api/rancher-users/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.rancher_users import rancher_users_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = rancher_users_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: rancher_users_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { rancherUsersList } from 'waldur-js-client';

try {
  const response = await rancherUsersList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
cluster_uuid string (uuid) Cluster UUID
is_active boolean
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
settings_uuid string (uuid)
user_full_name string User full name contains
user_username string
user_uuid string (uuid)

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
user string (uri)
cluster_roles array of objects
cluster_roles.cluster string (uri)
cluster_roles.role string (uri)
cluster_roles.cluster_name string
cluster_roles.cluster_uuid string (uuid)
project_roles array of objects
project_roles.project string (uri)
project_roles.role string (uri)
project_roles.project_name string
project_roles.project_uuid string (uuid)
settings string (uri)
is_active boolean
user_name string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
full_name string

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/rancher-users/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.rancher_users import rancher_users_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = rancher_users_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: rancher_users_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { rancherUsersRetrieve } from 'waldur-js-client';

try {
  const response = await rancherUsersRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
url string (uri)
uuid string (uuid)
user string (uri)
cluster_roles array of objects
cluster_roles.cluster string (uri)
cluster_roles.role string (uri)
cluster_roles.cluster_name string
cluster_roles.cluster_uuid string (uuid)
project_roles array of objects
project_roles.project string (uri)
project_roles.role string (uri)
project_roles.project_name string
project_roles.project_uuid string (uuid)
settings string (uri)
is_active boolean
user_name string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
full_name string

Rancher Workloads

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/rancher-workloads/ List Rancher Workloads
GET /api/rancher-workloads/{uuid}/ Retrieve
POST /api/rancher-workloads/ Create
PUT /api/rancher-workloads/{uuid}/ Update
PATCH /api/rancher-workloads/{uuid}/ Partial Update
DELETE /api/rancher-workloads/{uuid}/ Delete
Other Actions
GET /api/rancher-workloads/{uuid}/yaml/ Yaml
POST /api/rancher-workloads/{uuid}/redeploy/ Redeploy
PUT /api/rancher-workloads/{uuid}/yaml/ Yaml

Core CRUD

List Rancher Workloads

1
2
3
4
http \
  GET \
  https://api.example.com/api/rancher-workloads/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.rancher_workload_o_enum import RancherWorkloadOEnum # (1)
from waldur_api_client.api.rancher_workloads import rancher_workloads_list # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = rancher_workloads_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: RancherWorkloadOEnum
  2. API Source: rancher_workloads_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { rancherWorkloadsList } from 'waldur-js-client';

try {
  const response = await rancherWorkloadsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
cluster_uuid string (uuid)
name string Name
name_exact string Name (exact)
namespace_uuid string (uuid)
o array Ordering
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
project_uuid string (uuid)
settings string (uri) Settings URL
settings_uuid string (uuid) Settings UUID

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
url string (uri)
uuid string (uuid)
name string
created string (date-time)
modified string (date-time)
runtime_state string
cluster string (uri)
cluster_uuid string (uuid)
cluster_name string
project string (uri)
project_uuid string (uuid)
project_name string
namespace string (uri)
namespace_uuid string (uuid)
namespace_name string
scale integer

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/rancher-workloads/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.rancher_workloads import rancher_workloads_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = rancher_workloads_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: rancher_workloads_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { rancherWorkloadsRetrieve } from 'waldur-js-client';

try {
  const response = await rancherWorkloadsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
url string (uri)
uuid string (uuid)
name string
created string (date-time)
modified string (date-time)
runtime_state string
cluster string (uri)
cluster_uuid string (uuid)
cluster_name string
project string (uri)
project_uuid string (uuid)
project_name string
namespace string (uri)
namespace_uuid string (uuid)
namespace_name string
scale integer

Create

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/rancher-workloads/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-rancher-workload" \
  scale=123

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.rancher_workload_request import RancherWorkloadRequest # (1)
from waldur_api_client.api.rancher_workloads import rancher_workloads_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = RancherWorkloadRequest(
    name="my-awesome-rancher-workload",
    scale=123
)
response = rancher_workloads_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: RancherWorkloadRequest
  2. API Source: rancher_workloads_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { rancherWorkloadsCreate } from 'waldur-js-client';

try {
  const response = await rancherWorkloadsCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "name": "my-awesome-rancher-workload",
    "scale": 123
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required
name string ✓
runtime_state string
cluster string (uri)
project string (uri)
namespace string (uri)
scale integer ✓

201 -

Field Type
url string (uri)
uuid string (uuid)
name string
created string (date-time)
modified string (date-time)
runtime_state string
cluster string (uri)
cluster_uuid string (uuid)
cluster_name string
project string (uri)
project_uuid string (uuid)
project_name string
namespace string (uri)
namespace_uuid string (uuid)
namespace_name string
scale integer

Update

1
2
3
4
5
6
http \
  PUT \
  https://api.example.com/api/rancher-workloads/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-rancher-workload" \
  scale=123

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.rancher_workload_request import RancherWorkloadRequest # (1)
from waldur_api_client.api.rancher_workloads import rancher_workloads_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = RancherWorkloadRequest(
    name="my-awesome-rancher-workload",
    scale=123
)
response = rancher_workloads_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: RancherWorkloadRequest
  2. API Source: rancher_workloads_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { rancherWorkloadsUpdate } from 'waldur-js-client';

try {
  const response = await rancherWorkloadsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-rancher-workload",
    "scale": 123
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
name string ✓
runtime_state string
cluster string (uri)
project string (uri)
namespace string (uri)
scale integer ✓

200 -

Field Type
url string (uri)
uuid string (uuid)
name string
created string (date-time)
modified string (date-time)
runtime_state string
cluster string (uri)
cluster_uuid string (uuid)
cluster_name string
project string (uri)
project_uuid string (uuid)
project_name string
namespace string (uri)
namespace_uuid string (uuid)
namespace_name string
scale integer

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/rancher-workloads/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_rancher_workload_request import PatchedRancherWorkloadRequest # (1)
from waldur_api_client.api.rancher_workloads import rancher_workloads_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedRancherWorkloadRequest()
response = rancher_workloads_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedRancherWorkloadRequest
  2. API Source: rancher_workloads_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { rancherWorkloadsPartialUpdate } from 'waldur-js-client';

try {
  const response = await rancherWorkloadsPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
name string
runtime_state string
cluster string (uri)
project string (uri)
namespace string (uri)
scale integer

200 -

Field Type
url string (uri)
uuid string (uuid)
name string
created string (date-time)
modified string (date-time)
runtime_state string
cluster string (uri)
cluster_uuid string (uuid)
cluster_name string
project string (uri)
project_uuid string (uuid)
project_name string
namespace string (uri)
namespace_uuid string (uuid)
namespace_name string
scale integer

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/rancher-workloads/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.rancher_workloads import rancher_workloads_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = rancher_workloads_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: rancher_workloads_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { rancherWorkloadsDestroy } from 'waldur-js-client';

try {
  const response = await rancherWorkloadsDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Other Actions

Yaml

1
2
3
4
http \
  GET \
  https://api.example.com/api/rancher-workloads/a1b2c3d4-e5f6-7890-abcd-ef1234567890/yaml/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.rancher_workloads import rancher_workloads_yaml_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = rancher_workloads_yaml_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: rancher_workloads_yaml_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { rancherWorkloadsYamlRetrieve } from 'waldur-js-client';

try {
  const response = await rancherWorkloadsYamlRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
url string (uri)
uuid string (uuid)
name string
created string (date-time)
modified string (date-time)
runtime_state string
cluster string (uri)
cluster_uuid string (uuid)
cluster_name string
project string (uri)
project_uuid string (uuid)
project_name string
namespace string (uri)
namespace_uuid string (uuid)
namespace_name string
scale integer

Redeploy

1
2
3
4
http \
  POST \
  https://api.example.com/api/rancher-workloads/a1b2c3d4-e5f6-7890-abcd-ef1234567890/redeploy/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.rancher_workloads import rancher_workloads_redeploy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = rancher_workloads_redeploy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: rancher_workloads_redeploy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { rancherWorkloadsRedeploy } from 'waldur-js-client';

try {
  const response = await rancherWorkloadsRedeploy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 - No response body

Yaml

1
2
3
4
5
6
http \
  PUT \
  https://api.example.com/api/rancher-workloads/a1b2c3d4-e5f6-7890-abcd-ef1234567890/yaml/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-rancher-workload" \
  scale=123

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.rancher_workload_request import RancherWorkloadRequest # (1)
from waldur_api_client.api.rancher_workloads import rancher_workloads_yaml_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = RancherWorkloadRequest(
    name="my-awesome-rancher-workload",
    scale=123
)
response = rancher_workloads_yaml_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: RancherWorkloadRequest
  2. API Source: rancher_workloads_yaml_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { rancherWorkloadsYamlUpdate } from 'waldur-js-client';

try {
  const response = await rancherWorkloadsYamlUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-rancher-workload",
    "scale": 123
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
name string ✓
runtime_state string
cluster string (uri)
project string (uri)
namespace string (uri)
scale integer ✓

200 -

Field Type
url string (uri)
uuid string (uuid)
name string
created string (date-time)
modified string (date-time)
runtime_state string
cluster string (uri)
cluster_uuid string (uuid)
cluster_name string
project string (uri)
project_uuid string (uuid)
project_name string
namespace string (uri)
namespace_uuid string (uuid)
namespace_name string
scale integer

Slurm

Slurm Allocation User Usage

Operations Summary

Method Endpoint Description
GET /api/slurm-allocation-user-usage/ List Slurm Allocation User Usage
GET /api/slurm-allocation-user-usage/{id}/ Retrieve

List Slurm Allocation User Usage

1
2
3
4
http \
  GET \
  https://api.example.com/api/slurm-allocation-user-usage/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.slurm_allocation_user_usage import slurm_allocation_user_usage_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = slurm_allocation_user_usage_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: slurm_allocation_user_usage_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { slurmAllocationUserUsageList } from 'waldur-js-client';

try {
  const response = await slurmAllocationUserUsageList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
allocation string (uri)
allocation_uuid string (uuid)
month integer
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
user string (uri)
user_uuid string (uuid)
year integer

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
cpu_usage integer (int64)
ram_usage integer (int64)
gpu_usage integer (int64)
month integer
year integer
allocation string (uri)
user string (uri)
username string
full_name string

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/slurm-allocation-user-usage/123/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.slurm_allocation_user_usage import slurm_allocation_user_usage_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = slurm_allocation_user_usage_retrieve.sync(
    id=123,
    client=client
)

print(response)
  1. API Source: slurm_allocation_user_usage_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { slurmAllocationUserUsageRetrieve } from 'waldur-js-client';

try {
  const response = await slurmAllocationUserUsageRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "id": 123
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
id integer ✓ A unique integer value identifying this allocation user usage.

200 -

Field Type
cpu_usage integer (int64)
ram_usage integer (int64)
gpu_usage integer (int64)
month integer
year integer
allocation string (uri)
user string (uri)
username string
full_name string

Slurm Allocations

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/slurm-allocations/ List Slurm Allocations
GET /api/slurm-allocations/{uuid}/ Retrieve
POST /api/slurm-allocations/ Create
POST /api/slurm-allocations/{uuid}/pull/ Synchronize resource state
POST /api/slurm-allocations/{uuid}/unlink/ Unlink resource
PUT /api/slurm-allocations/{uuid}/ Update
PATCH /api/slurm-allocations/{uuid}/ Partial Update
DELETE /api/slurm-allocations/{uuid}/ Delete
Other Actions
POST /api/slurm-allocations/{uuid}/set_erred/ Mark resource as ERRED
POST /api/slurm-allocations/{uuid}/set_limits/ Set limits
POST /api/slurm-allocations/{uuid}/set_ok/ Mark resource as OK

Core CRUD

List Slurm Allocations

1
2
3
4
http \
  GET \
  https://api.example.com/api/slurm-allocations/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.core_states import CoreStates # (1)
from waldur_api_client.models.slurm_allocation_field_enum import SlurmAllocationFieldEnum # (2)
from waldur_api_client.api.slurm_allocations import slurm_allocations_list # (3)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = slurm_allocations_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: CoreStates
  2. Model Source: SlurmAllocationFieldEnum
  3. API Source: slurm_allocations_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { slurmAllocationsList } from 'waldur-js-client';

try {
  const response = await slurmAllocationsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
backend_id string Backend ID
can_manage boolean Can manage
customer string (uuid) Customer UUID
customer_abbreviation string Customer abbreviation
customer_name string Customer name
customer_native_name string Customer native name
customer_uuid string (uuid) Customer UUID
description string Description
external_ip string External IP
field array
is_active boolean
name string Name
name_exact string Name (exact)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
project string (uuid) Project UUID
project_name string Project name
project_uuid string (uuid) Project UUID
service_settings_name string Service settings name
service_settings_uuid string (uuid) Service settings UUID
state array State
uuid string (uuid) UUID

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
cpu_limit integer
cpu_usage integer
gpu_limit integer
gpu_usage integer
ram_limit integer
ram_usage integer
username string
gateway string
is_active boolean
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/slurm-allocations/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.slurm_allocation_field_enum import SlurmAllocationFieldEnum # (1)
from waldur_api_client.api.slurm_allocations import slurm_allocations_retrieve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = slurm_allocations_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. Model Source: SlurmAllocationFieldEnum
  2. API Source: slurm_allocations_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { slurmAllocationsRetrieve } from 'waldur-js-client';

try {
  const response = await slurmAllocationsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type
field array

200 -

Field Type
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
cpu_limit integer
cpu_usage integer
gpu_limit integer
gpu_usage integer
ram_limit integer
ram_usage integer
username string
gateway string
is_active boolean
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Create

1
2
3
4
5
6
7
http \
  POST \
  https://api.example.com/api/slurm-allocations/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-slurm-allocation" \
  service_settings="https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.slurm_allocation_request import SlurmAllocationRequest # (1)
from waldur_api_client.api.slurm_allocations import slurm_allocations_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = SlurmAllocationRequest(
    name="my-awesome-slurm-allocation",
    service_settings="https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = slurm_allocations_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: SlurmAllocationRequest
  2. API Source: slurm_allocations_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
import { slurmAllocationsCreate } from 'waldur-js-client';

try {
  const response = await slurmAllocationsCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "name": "my-awesome-slurm-allocation",
    "service_settings": "https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "project": "https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required
name string ✓
description string
service_settings string (uri) ✓
project string (uri) ✓

201 -

Field Type
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
cpu_limit integer
cpu_usage integer
gpu_limit integer
gpu_usage integer
ram_limit integer
ram_usage integer
username string
gateway string
is_active boolean
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Synchronize resource state

Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.

1
2
3
4
http \
  POST \
  https://api.example.com/api/slurm-allocations/a1b2c3d4-e5f6-7890-abcd-ef1234567890/pull/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.slurm_allocations import slurm_allocations_pull # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = slurm_allocations_pull.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: slurm_allocations_pull
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { slurmAllocationsPull } from 'waldur-js-client';

try {
  const response = await slurmAllocationsPull({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

202 -

Field Type
detail string

409 -

Field Type
detail string

Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state.

1
2
3
4
http \
  POST \
  https://api.example.com/api/slurm-allocations/a1b2c3d4-e5f6-7890-abcd-ef1234567890/unlink/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.slurm_allocations import slurm_allocations_unlink # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = slurm_allocations_unlink.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: slurm_allocations_unlink
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { slurmAllocationsUnlink } from 'waldur-js-client';

try {
  const response = await slurmAllocationsUnlink({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Update

1
2
3
4
5
6
7
http \
  PUT \
  https://api.example.com/api/slurm-allocations/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-slurm-allocation" \
  service_settings="https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.slurm_allocation_request import SlurmAllocationRequest # (1)
from waldur_api_client.api.slurm_allocations import slurm_allocations_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = SlurmAllocationRequest(
    name="my-awesome-slurm-allocation",
    service_settings="https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = slurm_allocations_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: SlurmAllocationRequest
  2. API Source: slurm_allocations_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
import { slurmAllocationsUpdate } from 'waldur-js-client';

try {
  const response = await slurmAllocationsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-slurm-allocation",
    "service_settings": "https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "project": "https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
name string ✓
description string
service_settings string (uri) ✓
project string (uri) ✓

200 -

Field Type
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
cpu_limit integer
cpu_usage integer
gpu_limit integer
gpu_usage integer
ram_limit integer
ram_usage integer
username string
gateway string
is_active boolean
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/slurm-allocations/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_slurm_allocation_request import PatchedSlurmAllocationRequest # (1)
from waldur_api_client.api.slurm_allocations import slurm_allocations_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedSlurmAllocationRequest()
response = slurm_allocations_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedSlurmAllocationRequest
  2. API Source: slurm_allocations_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { slurmAllocationsPartialUpdate } from 'waldur-js-client';

try {
  const response = await slurmAllocationsPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
name string
description string

200 -

Field Type
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
cpu_limit integer
cpu_usage integer
gpu_limit integer
gpu_usage integer
ram_limit integer
ram_usage integer
username string
gateway string
is_active boolean
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/slurm-allocations/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.slurm_allocations import slurm_allocations_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = slurm_allocations_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: slurm_allocations_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { slurmAllocationsDestroy } from 'waldur-js-client';

try {
  const response = await slurmAllocationsDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Other Actions

Mark resource as ERRED

Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.

1
2
3
4
http \
  POST \
  https://api.example.com/api/slurm-allocations/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_erred/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.set_erred_request import SetErredRequest # (1)
from waldur_api_client.api.slurm_allocations import slurm_allocations_set_erred # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = SetErredRequest()
response = slurm_allocations_set_erred.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: SetErredRequest
  2. API Source: slurm_allocations_set_erred
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { slurmAllocationsSetErred } from 'waldur-js-client';

try {
  const response = await slurmAllocationsSetErred({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
error_message string
error_traceback string

200 -

Field Type
detail string

Set limits

1
2
3
4
5
6
7
http \
  POST \
  https://api.example.com/api/slurm-allocations/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_limits/ \
  Authorization:"Token YOUR_API_TOKEN" \
  cpu_limit=123 \
  gpu_limit=123 \
  ram_limit=2048

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.slurm_allocation_set_limits_request import SlurmAllocationSetLimitsRequest # (1)
from waldur_api_client.api.slurm_allocations import slurm_allocations_set_limits # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = SlurmAllocationSetLimitsRequest(
    cpu_limit=123,
    gpu_limit=123,
    ram_limit=2048
)
response = slurm_allocations_set_limits.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: SlurmAllocationSetLimitsRequest
  2. API Source: slurm_allocations_set_limits
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
import { slurmAllocationsSetLimits } from 'waldur-js-client';

try {
  const response = await slurmAllocationsSetLimits({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "cpu_limit": 123,
    "gpu_limit": 123,
    "ram_limit": 2048
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
cpu_limit integer ✓
gpu_limit integer ✓
ram_limit integer ✓

200 -

Field Type
cpu_limit integer
gpu_limit integer
ram_limit integer

Mark resource as OK

Manually transition the resource to OK state and clear error fields. Staff-only operation.

1
2
3
4
http \
  POST \
  https://api.example.com/api/slurm-allocations/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_ok/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.slurm_allocations import slurm_allocations_set_ok # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = slurm_allocations_set_ok.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: slurm_allocations_set_ok
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { slurmAllocationsSetOk } from 'waldur-js-client';

try {
  const response = await slurmAllocationsSetOk({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
detail string

Slurm Associations

Operations Summary

Method Endpoint Description
GET /api/slurm-associations/ List Slurm Associations
GET /api/slurm-associations/{uuid}/ Retrieve

List Slurm Associations

1
2
3
4
http \
  GET \
  https://api.example.com/api/slurm-associations/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.slurm_associations import slurm_associations_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = slurm_associations_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: slurm_associations_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { slurmAssociationsList } from 'waldur-js-client';

try {
  const response = await slurmAssociationsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
allocation string (uri)
allocation_uuid string (uuid)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
uuid string (uuid)
username string
allocation string (uri)

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/slurm-associations/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.slurm_associations import slurm_associations_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = slurm_associations_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: slurm_associations_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { slurmAssociationsRetrieve } from 'waldur-js-client';

try {
  const response = await slurmAssociationsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
uuid string (uuid)
username string
allocation string (uri)

Slurm Jobs

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/slurm-jobs/ List Slurm Jobs
GET /api/slurm-jobs/{uuid}/ Retrieve
POST /api/slurm-jobs/ Create
POST /api/slurm-jobs/{uuid}/pull/ Synchronize resource state
POST /api/slurm-jobs/{uuid}/unlink/ Unlink resource
PUT /api/slurm-jobs/{uuid}/ Update
PATCH /api/slurm-jobs/{uuid}/ Partial Update
DELETE /api/slurm-jobs/{uuid}/ Delete
Other Actions
POST /api/slurm-jobs/{uuid}/set_erred/ Mark resource as ERRED
POST /api/slurm-jobs/{uuid}/set_ok/ Mark resource as OK

Core CRUD

List Slurm Jobs

1
2
3
4
http \
  GET \
  https://api.example.com/api/slurm-jobs/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.firecrest_job_field_enum import FirecrestJobFieldEnum # (1)
from waldur_api_client.api.slurm_jobs import slurm_jobs_list # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = slurm_jobs_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: FirecrestJobFieldEnum
  2. API Source: slurm_jobs_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { slurmJobsList } from 'waldur-js-client';

try {
  const response = await slurmJobsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
field array
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
runtime_state string
file string (uri)
user string (uri) Reference to user which submitted job
user_uuid string (uuid)
user_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
report any

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/slurm-jobs/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.firecrest_job_field_enum import FirecrestJobFieldEnum # (1)
from waldur_api_client.api.slurm_jobs import slurm_jobs_retrieve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = slurm_jobs_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. Model Source: FirecrestJobFieldEnum
  2. API Source: slurm_jobs_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { slurmJobsRetrieve } from 'waldur-js-client';

try {
  const response = await slurmJobsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type
field array

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
runtime_state string
file string (uri)
user string (uri) Reference to user which submitted job
user_uuid string (uuid)
user_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
report any

Create

1
2
3
4
5
6
7
8
http \
  POST \
  https://api.example.com/api/slurm-jobs/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-slurm-job" \
  service_settings="https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  file="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.firecrest_job_request import FirecrestJobRequest # (1)
from waldur_api_client.api.slurm_jobs import slurm_jobs_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = FirecrestJobRequest(
    name="my-awesome-slurm-job",
    service_settings="https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    file="string-value"
)
response = slurm_jobs_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: FirecrestJobRequest
  2. API Source: slurm_jobs_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { slurmJobsCreate } from 'waldur-js-client';

try {
  const response = await slurmJobsCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "name": "my-awesome-slurm-job",
    "service_settings": "https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "project": "https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "file": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required
name string ✓
description string
service_settings string (uri) ✓
project string (uri) ✓
runtime_state string
file string (binary) ✓

201 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
runtime_state string
file string (uri)
user string (uri) Reference to user which submitted job
user_uuid string (uuid)
user_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
report any

Synchronize resource state

Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.

1
2
3
4
http \
  POST \
  https://api.example.com/api/slurm-jobs/a1b2c3d4-e5f6-7890-abcd-ef1234567890/pull/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.slurm_jobs import slurm_jobs_pull # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = slurm_jobs_pull.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: slurm_jobs_pull
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { slurmJobsPull } from 'waldur-js-client';

try {
  const response = await slurmJobsPull({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

202 -

Field Type
detail string

409 -

Field Type
detail string

Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state.

1
2
3
4
http \
  POST \
  https://api.example.com/api/slurm-jobs/a1b2c3d4-e5f6-7890-abcd-ef1234567890/unlink/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.slurm_jobs import slurm_jobs_unlink # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = slurm_jobs_unlink.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: slurm_jobs_unlink
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { slurmJobsUnlink } from 'waldur-js-client';

try {
  const response = await slurmJobsUnlink({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Update

1
2
3
4
5
6
7
8
http \
  PUT \
  https://api.example.com/api/slurm-jobs/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-slurm-job" \
  service_settings="https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  file="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.firecrest_job_request import FirecrestJobRequest # (1)
from waldur_api_client.api.slurm_jobs import slurm_jobs_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = FirecrestJobRequest(
    name="my-awesome-slurm-job",
    service_settings="https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    file="string-value"
)
response = slurm_jobs_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: FirecrestJobRequest
  2. API Source: slurm_jobs_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
import { slurmJobsUpdate } from 'waldur-js-client';

try {
  const response = await slurmJobsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-slurm-job",
    "service_settings": "https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "project": "https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "file": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
name string ✓
description string
service_settings string (uri) ✓
project string (uri) ✓
runtime_state string
file string (binary) ✓

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
runtime_state string
file string (uri)
user string (uri) Reference to user which submitted job
user_uuid string (uuid)
user_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
report any

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/slurm-jobs/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_firecrest_job_request import PatchedFirecrestJobRequest # (1)
from waldur_api_client.api.slurm_jobs import slurm_jobs_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedFirecrestJobRequest()
response = slurm_jobs_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedFirecrestJobRequest
  2. API Source: slurm_jobs_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { slurmJobsPartialUpdate } from 'waldur-js-client';

try {
  const response = await slurmJobsPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
name string
description string
runtime_state string

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
runtime_state string
file string (uri)
user string (uri) Reference to user which submitted job
user_uuid string (uuid)
user_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
report any

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/slurm-jobs/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.slurm_jobs import slurm_jobs_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = slurm_jobs_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: slurm_jobs_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { slurmJobsDestroy } from 'waldur-js-client';

try {
  const response = await slurmJobsDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Other Actions

Mark resource as ERRED

Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.

1
2
3
4
http \
  POST \
  https://api.example.com/api/slurm-jobs/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_erred/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.set_erred_request import SetErredRequest # (1)
from waldur_api_client.api.slurm_jobs import slurm_jobs_set_erred # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = SetErredRequest()
response = slurm_jobs_set_erred.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: SetErredRequest
  2. API Source: slurm_jobs_set_erred
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { slurmJobsSetErred } from 'waldur-js-client';

try {
  const response = await slurmJobsSetErred({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
error_message string
error_traceback string

200 -

Field Type
detail string

Mark resource as OK

Manually transition the resource to OK state and clear error fields. Staff-only operation.

1
2
3
4
http \
  POST \
  https://api.example.com/api/slurm-jobs/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_ok/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.slurm_jobs import slurm_jobs_set_ok # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = slurm_jobs_set_ok.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: slurm_jobs_set_ok
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { slurmJobsSetOk } from 'waldur-js-client';

try {
  const response = await slurmJobsSetOk({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
detail string

Marketplace Slurm Periodic Usage Policies

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/marketplace-slurm-periodic-usage-policies/ List Marketplace Slurm Periodic Usage Policies
GET /api/marketplace-slurm-periodic-usage-policies/{uuid}/ Retrieve
POST /api/marketplace-slurm-periodic-usage-policies/ Create
PUT /api/marketplace-slurm-periodic-usage-policies/{uuid}/ Update
PATCH /api/marketplace-slurm-periodic-usage-policies/{uuid}/ Partial Update
DELETE /api/marketplace-slurm-periodic-usage-policies/{uuid}/ Delete
Other Actions
GET /api/marketplace-slurm-periodic-usage-policies/actions/ List Marketplace Slurm Periodic Usage Policies Actions
GET /api/marketplace-slurm-periodic-usage-policies/{uuid}/command-history/ List command history for this policy
GET /api/marketplace-slurm-periodic-usage-policies/{uuid}/evaluation-logs/ List evaluation logs for this policy
POST /api/marketplace-slurm-periodic-usage-policies/{uuid}/dry-run/ Dry run
POST /api/marketplace-slurm-periodic-usage-policies/{uuid}/evaluate/ Evaluate
POST /api/marketplace-slurm-periodic-usage-policies/preview_impact/ Preview impact
POST /api/marketplace-slurm-periodic-usage-policies/{uuid}/report-command-result/ Report command execution result from site agent

Core CRUD

List Marketplace Slurm Periodic Usage Policies

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-slurm-periodic-usage-policies/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_slurm_periodic_usage_policies import marketplace_slurm_periodic_usage_policies_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_slurm_periodic_usage_policies_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: marketplace_slurm_periodic_usage_policies_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceSlurmPeriodicUsagePoliciesList } from 'waldur-js-client';

try {
  const response = await marketplaceSlurmPeriodicUsagePoliciesList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
scope string (uri)
scope_uuid string (uuid)

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid)
url string (uri)
scope string (uri)
scope_name string
scope_uuid string (uuid)
actions string
created string (date-time)
created_by_full_name string
created_by_username string
has_fired boolean
fired_datetime string (date-time)
options any Fields for saving actions extra data. Keys are name of actions.
organization_groups array of string (uri)s
apply_to_all boolean If True, policy applies to all customers. Mutually exclusive with organization_groups.
component_limits_set array of objects
component_limits_set.type string
component_limits_set.limit integer
period any
period_name string
limit_type any SLURM limit type to apply
tres_billing_enabled boolean Use TRES billing units instead of raw TRES values
tres_billing_weights any TRES billing weights (e.g., {"CPU": 0.015625, "Mem": 0.001953125, "GRES/gpu": 0.25})
carryover_factor integer Maximum percentage of base allocation that can carry over from unused previous period (0-100)
grace_ratio number (double) Grace period ratio (0.2 = 20% overconsumption allowed)
carryover_enabled boolean Enable unused allocation carryover to next period
raw_usage_reset boolean Reset raw usage at period transitions (PriorityUsageResetPeriod=None)
qos_strategy any QoS management strategy
warnings array of strings Warnings about misconfiguration, e.g. missing site agent queue registration.

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-slurm-periodic-usage-policies/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_slurm_periodic_usage_policies import marketplace_slurm_periodic_usage_policies_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_slurm_periodic_usage_policies_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_slurm_periodic_usage_policies_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceSlurmPeriodicUsagePoliciesRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceSlurmPeriodicUsagePoliciesRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
uuid string (uuid)
url string (uri)
scope string (uri)
scope_name string
scope_uuid string (uuid)
actions string
created string (date-time)
created_by_full_name string
created_by_username string
has_fired boolean
fired_datetime string (date-time)
options any Fields for saving actions extra data. Keys are name of actions.
organization_groups array of string (uri)s
apply_to_all boolean If True, policy applies to all customers. Mutually exclusive with organization_groups.
component_limits_set array of objects
component_limits_set.type string
component_limits_set.limit integer
period any
period_name string
limit_type any SLURM limit type to apply
tres_billing_enabled boolean Use TRES billing units instead of raw TRES values
tres_billing_weights any TRES billing weights (e.g., {"CPU": 0.015625, "Mem": 0.001953125, "GRES/gpu": 0.25})
carryover_factor integer Maximum percentage of base allocation that can carry over from unused previous period (0-100)
grace_ratio number (double) Grace period ratio (0.2 = 20% overconsumption allowed)
carryover_enabled boolean Enable unused allocation carryover to next period
raw_usage_reset boolean Reset raw usage at period transitions (PriorityUsageResetPeriod=None)
qos_strategy any QoS management strategy
warnings array of strings Warnings about misconfiguration, e.g. missing site agent queue registration.

Create

1
2
3
4
5
6
7
http \
  POST \
  https://api.example.com/api/marketplace-slurm-periodic-usage-policies/ \
  Authorization:"Token YOUR_API_TOKEN" \
  scope="https://api.example.com/api/scope/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  actions="string-value" \
  component_limits_set:='[]'

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.slurm_periodic_usage_policy_request import SlurmPeriodicUsagePolicyRequest # (1)
from waldur_api_client.api.marketplace_slurm_periodic_usage_policies import marketplace_slurm_periodic_usage_policies_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = SlurmPeriodicUsagePolicyRequest(
    scope="https://api.example.com/api/scope/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    actions="string-value",
    component_limits_set=[]
)
response = marketplace_slurm_periodic_usage_policies_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: SlurmPeriodicUsagePolicyRequest
  2. API Source: marketplace_slurm_periodic_usage_policies_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
import { marketplaceSlurmPeriodicUsagePoliciesCreate } from 'waldur-js-client';

try {
  const response = await marketplaceSlurmPeriodicUsagePoliciesCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "scope": "https://api.example.com/api/scope/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "actions": "string-value",
    "component_limits_set": []
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
scope string (uri) ✓
actions string ✓
options any Fields for saving actions extra data. Keys are name of actions.
organization_groups array of string (uri)s
apply_to_all boolean If True, policy applies to all customers. Mutually exclusive with organization_groups.
component_limits_set array of objects ✓
component_limits_set.type string ✓
component_limits_set.limit integer ✓
period any
limit_type any SLURM limit type to apply
tres_billing_enabled boolean Use TRES billing units instead of raw TRES values
tres_billing_weights any TRES billing weights (e.g., {"CPU": 0.015625, "Mem": 0.001953125, "GRES/gpu": 0.25})
carryover_factor integer Maximum percentage of base allocation that can carry over from unused previous period (0-100)
grace_ratio number (double) Grace period ratio (0.2 = 20% overconsumption allowed)
carryover_enabled boolean Enable unused allocation carryover to next period
raw_usage_reset boolean Reset raw usage at period transitions (PriorityUsageResetPeriod=None)
qos_strategy any QoS management strategy

201 -

Field Type Description
uuid string (uuid)
url string (uri)
scope string (uri)
scope_name string
scope_uuid string (uuid)
actions string
created string (date-time)
created_by_full_name string
created_by_username string
has_fired boolean
fired_datetime string (date-time)
options any Fields for saving actions extra data. Keys are name of actions.
organization_groups array of string (uri)s
apply_to_all boolean If True, policy applies to all customers. Mutually exclusive with organization_groups.
component_limits_set array of objects
component_limits_set.type string
component_limits_set.limit integer
period any
period_name string
limit_type any SLURM limit type to apply
tres_billing_enabled boolean Use TRES billing units instead of raw TRES values
tres_billing_weights any TRES billing weights (e.g., {"CPU": 0.015625, "Mem": 0.001953125, "GRES/gpu": 0.25})
carryover_factor integer Maximum percentage of base allocation that can carry over from unused previous period (0-100)
grace_ratio number (double) Grace period ratio (0.2 = 20% overconsumption allowed)
carryover_enabled boolean Enable unused allocation carryover to next period
raw_usage_reset boolean Reset raw usage at period transitions (PriorityUsageResetPeriod=None)
qos_strategy any QoS management strategy
warnings array of strings Warnings about misconfiguration, e.g. missing site agent queue registration.

Update

1
2
3
4
5
6
7
http \
  PUT \
  https://api.example.com/api/marketplace-slurm-periodic-usage-policies/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  scope="https://api.example.com/api/scope/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  actions="string-value" \
  component_limits_set:='[]'

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.slurm_periodic_usage_policy_request import SlurmPeriodicUsagePolicyRequest # (1)
from waldur_api_client.api.marketplace_slurm_periodic_usage_policies import marketplace_slurm_periodic_usage_policies_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = SlurmPeriodicUsagePolicyRequest(
    scope="https://api.example.com/api/scope/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    actions="string-value",
    component_limits_set=[]
)
response = marketplace_slurm_periodic_usage_policies_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: SlurmPeriodicUsagePolicyRequest
  2. API Source: marketplace_slurm_periodic_usage_policies_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
import { marketplaceSlurmPeriodicUsagePoliciesUpdate } from 'waldur-js-client';

try {
  const response = await marketplaceSlurmPeriodicUsagePoliciesUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "scope": "https://api.example.com/api/scope/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "actions": "string-value",
    "component_limits_set": []
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
scope string (uri) ✓
actions string ✓
options any Fields for saving actions extra data. Keys are name of actions.
organization_groups array of string (uri)s
apply_to_all boolean If True, policy applies to all customers. Mutually exclusive with organization_groups.
component_limits_set array of objects ✓
component_limits_set.type string ✓
component_limits_set.limit integer ✓
period any
limit_type any SLURM limit type to apply
tres_billing_enabled boolean Use TRES billing units instead of raw TRES values
tres_billing_weights any TRES billing weights (e.g., {"CPU": 0.015625, "Mem": 0.001953125, "GRES/gpu": 0.25})
carryover_factor integer Maximum percentage of base allocation that can carry over from unused previous period (0-100)
grace_ratio number (double) Grace period ratio (0.2 = 20% overconsumption allowed)
carryover_enabled boolean Enable unused allocation carryover to next period
raw_usage_reset boolean Reset raw usage at period transitions (PriorityUsageResetPeriod=None)
qos_strategy any QoS management strategy

200 -

Field Type Description
uuid string (uuid)
url string (uri)
scope string (uri)
scope_name string
scope_uuid string (uuid)
actions string
created string (date-time)
created_by_full_name string
created_by_username string
has_fired boolean
fired_datetime string (date-time)
options any Fields for saving actions extra data. Keys are name of actions.
organization_groups array of string (uri)s
apply_to_all boolean If True, policy applies to all customers. Mutually exclusive with organization_groups.
component_limits_set array of objects
component_limits_set.type string
component_limits_set.limit integer
period any
period_name string
limit_type any SLURM limit type to apply
tres_billing_enabled boolean Use TRES billing units instead of raw TRES values
tres_billing_weights any TRES billing weights (e.g., {"CPU": 0.015625, "Mem": 0.001953125, "GRES/gpu": 0.25})
carryover_factor integer Maximum percentage of base allocation that can carry over from unused previous period (0-100)
grace_ratio number (double) Grace period ratio (0.2 = 20% overconsumption allowed)
carryover_enabled boolean Enable unused allocation carryover to next period
raw_usage_reset boolean Reset raw usage at period transitions (PriorityUsageResetPeriod=None)
qos_strategy any QoS management strategy
warnings array of strings Warnings about misconfiguration, e.g. missing site agent queue registration.

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/marketplace-slurm-periodic-usage-policies/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_slurm_periodic_usage_policy_request import PatchedSlurmPeriodicUsagePolicyRequest # (1)
from waldur_api_client.api.marketplace_slurm_periodic_usage_policies import marketplace_slurm_periodic_usage_policies_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedSlurmPeriodicUsagePolicyRequest()
response = marketplace_slurm_periodic_usage_policies_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedSlurmPeriodicUsagePolicyRequest
  2. API Source: marketplace_slurm_periodic_usage_policies_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceSlurmPeriodicUsagePoliciesPartialUpdate } from 'waldur-js-client';

try {
  const response = await marketplaceSlurmPeriodicUsagePoliciesPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
scope string (uri)
actions string
options any Fields for saving actions extra data. Keys are name of actions.
organization_groups array of string (uri)s
apply_to_all boolean If True, policy applies to all customers. Mutually exclusive with organization_groups.
component_limits_set array of objects
component_limits_set.type string ✓
component_limits_set.limit integer ✓
period any
limit_type any SLURM limit type to apply
tres_billing_enabled boolean Use TRES billing units instead of raw TRES values
tres_billing_weights any TRES billing weights (e.g., {"CPU": 0.015625, "Mem": 0.001953125, "GRES/gpu": 0.25})
carryover_factor integer Maximum percentage of base allocation that can carry over from unused previous period (0-100)
grace_ratio number (double) Grace period ratio (0.2 = 20% overconsumption allowed)
carryover_enabled boolean Enable unused allocation carryover to next period
raw_usage_reset boolean Reset raw usage at period transitions (PriorityUsageResetPeriod=None)
qos_strategy any QoS management strategy

200 -

Field Type Description
uuid string (uuid)
url string (uri)
scope string (uri)
scope_name string
scope_uuid string (uuid)
actions string
created string (date-time)
created_by_full_name string
created_by_username string
has_fired boolean
fired_datetime string (date-time)
options any Fields for saving actions extra data. Keys are name of actions.
organization_groups array of string (uri)s
apply_to_all boolean If True, policy applies to all customers. Mutually exclusive with organization_groups.
component_limits_set array of objects
component_limits_set.type string
component_limits_set.limit integer
period any
period_name string
limit_type any SLURM limit type to apply
tres_billing_enabled boolean Use TRES billing units instead of raw TRES values
tres_billing_weights any TRES billing weights (e.g., {"CPU": 0.015625, "Mem": 0.001953125, "GRES/gpu": 0.25})
carryover_factor integer Maximum percentage of base allocation that can carry over from unused previous period (0-100)
grace_ratio number (double) Grace period ratio (0.2 = 20% overconsumption allowed)
carryover_enabled boolean Enable unused allocation carryover to next period
raw_usage_reset boolean Reset raw usage at period transitions (PriorityUsageResetPeriod=None)
qos_strategy any QoS management strategy
warnings array of strings Warnings about misconfiguration, e.g. missing site agent queue registration.

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/marketplace-slurm-periodic-usage-policies/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_slurm_periodic_usage_policies import marketplace_slurm_periodic_usage_policies_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_slurm_periodic_usage_policies_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_slurm_periodic_usage_policies_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceSlurmPeriodicUsagePoliciesDestroy } from 'waldur-js-client';

try {
  const response = await marketplaceSlurmPeriodicUsagePoliciesDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Other Actions

List Marketplace Slurm Periodic Usage Policies Actions

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-slurm-periodic-usage-policies/actions/ \
  Authorization:"Token YOUR_API_TOKEN"

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_slurm_periodic_usage_policies import marketplace_slurm_periodic_usage_policies_actions_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_slurm_periodic_usage_policies_actions_retrieve.sync(client=client)

print(response)
  1. API Source: marketplace_slurm_periodic_usage_policies_actions_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceSlurmPeriodicUsagePoliciesActionsRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceSlurmPeriodicUsagePoliciesActionsRetrieve({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

200 -

Field Type Description
uuid string (uuid)
url string (uri)
scope string (uri)
scope_name string
scope_uuid string (uuid)
actions string
created string (date-time)
created_by_full_name string
created_by_username string
has_fired boolean
fired_datetime string (date-time)
options any Fields for saving actions extra data. Keys are name of actions.
organization_groups array of string (uri)s
apply_to_all boolean If True, policy applies to all customers. Mutually exclusive with organization_groups.
component_limits_set array of objects
component_limits_set.type string
component_limits_set.limit integer
period any
period_name string
limit_type any SLURM limit type to apply
tres_billing_enabled boolean Use TRES billing units instead of raw TRES values
tres_billing_weights any TRES billing weights (e.g., {"CPU": 0.015625, "Mem": 0.001953125, "GRES/gpu": 0.25})
carryover_factor integer Maximum percentage of base allocation that can carry over from unused previous period (0-100)
grace_ratio number (double) Grace period ratio (0.2 = 20% overconsumption allowed)
carryover_enabled boolean Enable unused allocation carryover to next period
raw_usage_reset boolean Reset raw usage at period transitions (PriorityUsageResetPeriod=None)
qos_strategy any QoS management strategy
warnings array of strings Warnings about misconfiguration, e.g. missing site agent queue registration.

List command history for this policy

List command history for this policy.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-slurm-periodic-usage-policies/a1b2c3d4-e5f6-7890-abcd-ef1234567890/command-history/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_slurm_periodic_usage_policies import marketplace_slurm_periodic_usage_policies_command_history_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_slurm_periodic_usage_policies_command_history_list.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

for item in response:
    print(item)
  1. API Source: marketplace_slurm_periodic_usage_policies_command_history_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceSlurmPeriodicUsagePoliciesCommandHistoryList } from 'waldur-js-client';

try {
  const response = await marketplaceSlurmPeriodicUsagePoliciesCommandHistoryList({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
scope string (uri)
scope_uuid string (uuid)

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid)
command_type string Type of command: fairshare, limits, qos, reset_usage
description string Human-readable description of what the command does
shell_command string Actual shell command that was/would be executed
parameters any Command parameters as key-value pairs
executed_at string (date-time)
execution_mode any Whether command was executed in production or emulator mode
success boolean Whether the command execution was successful
error_message string Error message if command execution failed

List evaluation logs for this policy

List evaluation logs for this policy.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-slurm-periodic-usage-policies/a1b2c3d4-e5f6-7890-abcd-ef1234567890/evaluation-logs/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_slurm_periodic_usage_policies import marketplace_slurm_periodic_usage_policies_evaluation_logs_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_slurm_periodic_usage_policies_evaluation_logs_list.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

for item in response:
    print(item)
  1. API Source: marketplace_slurm_periodic_usage_policies_evaluation_logs_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceSlurmPeriodicUsagePoliciesEvaluationLogsList } from 'waldur-js-client';

try {
  const response = await marketplaceSlurmPeriodicUsagePoliciesEvaluationLogsList({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
scope string (uri)
scope_uuid string (uuid)

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid)
resource_uuid string (uuid)
resource_name string
billing_period string Billing period identifier, e.g. '2026-Q1'
usage_percentage number (double) Resource usage percentage at the time of evaluation
grace_limit_percentage number (double) Grace limit percentage threshold (e.g. 120 for 20% grace)
actions_taken any List of actions taken during this evaluation (e.g. ['pause', 'notify'])
previous_state any Resource state before evaluation:
new_state any Resource state after evaluation:
stomp_message_sent boolean Whether a STOMP message was sent to the site agent
site_agent_confirmed boolean Whether the site agent confirmed command execution (null = no response yet)
site_agent_response any Response payload from the site agent
evaluated_at string (date-time) When this evaluation was performed

Dry run

Staff-only. Dry-run evaluation: calculates usage percentages and shows what actions would be triggered, without applying any changes.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-slurm-periodic-usage-policies/a1b2c3d4-e5f6-7890-abcd-ef1234567890/dry-run/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.slurm_policy_evaluate_request_request import SlurmPolicyEvaluateRequestRequest # (1)
from waldur_api_client.api.marketplace_slurm_periodic_usage_policies import marketplace_slurm_periodic_usage_policies_dry_run # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = SlurmPolicyEvaluateRequestRequest()
response = marketplace_slurm_periodic_usage_policies_dry_run.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: SlurmPolicyEvaluateRequestRequest
  2. API Source: marketplace_slurm_periodic_usage_policies_dry_run
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceSlurmPeriodicUsagePoliciesDryRun } from 'waldur-js-client';

try {
  const response = await marketplaceSlurmPeriodicUsagePoliciesDryRun({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
resource_uuid string (uuid) Evaluate a specific resource. If omitted, evaluates all offering resources.

200 -

Field Type
policy_uuid string (uuid)
billing_period string
grace_limit_percentage number (double)
resources array of objects
resources.resource_uuid string (uuid)
resources.resource_name string
resources.usage_percentage number (double)
resources.paused boolean
resources.downscaled boolean
resources.would_trigger array of strings

Evaluate

Staff-only. Run synchronous policy evaluation: calculates usage, applies actions (pause/downscale/notify), and creates evaluation logs.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-slurm-periodic-usage-policies/a1b2c3d4-e5f6-7890-abcd-ef1234567890/evaluate/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.slurm_policy_evaluate_request_request import SlurmPolicyEvaluateRequestRequest # (1)
from waldur_api_client.api.marketplace_slurm_periodic_usage_policies import marketplace_slurm_periodic_usage_policies_evaluate # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = SlurmPolicyEvaluateRequestRequest()
response = marketplace_slurm_periodic_usage_policies_evaluate.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: SlurmPolicyEvaluateRequestRequest
  2. API Source: marketplace_slurm_periodic_usage_policies_evaluate
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceSlurmPeriodicUsagePoliciesEvaluate } from 'waldur-js-client';

try {
  const response = await marketplaceSlurmPeriodicUsagePoliciesEvaluate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
resource_uuid string (uuid) Evaluate a specific resource. If omitted, evaluates all offering resources.

200 -

Field Type
policy_uuid string (uuid)
billing_period string
resources array of objects
resources.resource_uuid string (uuid)
resources.resource_name string
resources.usage_percentage number (double)
resources.actions_taken array of strings
resources.previous_state object (free-form)
resources.new_state object (free-form)

Preview impact

Preview policy impact without saving. Returns threshold calculations, carryover projections, and QoS trigger points.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-slurm-periodic-usage-policies/preview_impact/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.slurm_policy_preview_request_request import SlurmPolicyPreviewRequestRequest # (1)
from waldur_api_client.api.marketplace_slurm_periodic_usage_policies import marketplace_slurm_periodic_usage_policies_preview_impact # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = SlurmPolicyPreviewRequestRequest()
response = marketplace_slurm_periodic_usage_policies_preview_impact.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: SlurmPolicyPreviewRequestRequest
  2. API Source: marketplace_slurm_periodic_usage_policies_preview_impact
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceSlurmPeriodicUsagePoliciesPreviewImpact } from 'waldur-js-client';

try {
  const response = await marketplaceSlurmPeriodicUsagePoliciesPreviewImpact({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
allocation number (double) Base allocation for the period (in node-hours or billing units)
Constraints: default: 1000.0
grace_ratio number (double) Grace ratio for overconsumption allowance (0.2 = 20%)
Constraints: default: 0.2
previous_usage number (double) Usage from the previous period
Constraints: default: 0.0
carryover_factor integer Maximum percentage of base allocation that can carry over (0-100)
Constraints: default: 50
carryover_enabled boolean Whether unused allocation carries over to next period
Constraints: default: True
resource_uuid string (uuid) Optional resource UUID to use for current usage data
current_usage number (double) Current usage in this period (manual input or from resource)
Constraints: default: 0.0
daily_usage_rate number (double) Average daily usage rate for projections
Constraints: default: 0.0

200 -

Field Type Description
base_allocation number (double)
effective_allocation number (double)
carryover_enabled boolean
carryover any
thresholds object
thresholds.allocation number (double)
thresholds.grace_ratio number (double)
thresholds.notification_ratio number (double)
thresholds.notification_threshold number (double)
thresholds.slowdown_threshold number (double)
thresholds.blocked_threshold number (double)
grace_ratio number (double)
carryover_factor integer
current_usage number (double)
daily_usage_rate number (double)
usage_percentage number (double)
current_qos_status string
Enum: normal, notification, slowdown, blocked
date_projections object
date_projections.notification object
date_projections.notification.days integer
date_projections.notification.date string (date)
date_projections.notification.status string
Enum: never, exceeded, projected
date_projections.slowdown object
date_projections.slowdown.days integer
date_projections.slowdown.date string (date)
date_projections.slowdown.status string
Enum: never, exceeded, projected
date_projections.blocked object
date_projections.blocked.days integer
date_projections.blocked.date string (date)
date_projections.blocked.status string
Enum: never, exceeded, projected
preview_commands array of objects
preview_commands.type string Command type: fairshare, limits, qos, reset_usage
preview_commands.description string Human-readable description
preview_commands.command string Actual shell command
preview_commands.parameters object (free-form) Command parameters
command_history array of objects
command_history.uuid string (uuid)
command_history.command_type string Type of command: fairshare, limits, qos, reset_usage
command_history.description string Human-readable description of what the command does
command_history.shell_command string Actual shell command that was/would be executed
command_history.parameters any Command parameters as key-value pairs
command_history.executed_at string (date-time)
command_history.execution_mode any Whether command was executed in production or emulator mode
command_history.success boolean Whether the command execution was successful
command_history.error_message string Error message if command execution failed
billing_period_start string (date)
billing_period_end string (date)

Report command execution result from site agent

Report command execution result from site agent.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/marketplace-slurm-periodic-usage-policies/a1b2c3d4-e5f6-7890-abcd-ef1234567890/report-command-result/ \
  Authorization:"Token YOUR_API_TOKEN" \
  resource_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  success=true

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.slurm_command_result_request import SlurmCommandResultRequest # (1)
from waldur_api_client.api.marketplace_slurm_periodic_usage_policies import marketplace_slurm_periodic_usage_policies_report_command_result # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = SlurmCommandResultRequest(
    resource_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    success=true
)
response = marketplace_slurm_periodic_usage_policies_report_command_result.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: SlurmCommandResultRequest
  2. API Source: marketplace_slurm_periodic_usage_policies_report_command_result
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { marketplaceSlurmPeriodicUsagePoliciesReportCommandResult } from 'waldur-js-client';

try {
  const response = await marketplaceSlurmPeriodicUsagePoliciesReportCommandResult({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "resource_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "success": true
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
resource_uuid string (uuid) ✓ UUID of the resource the command was applied to
success boolean ✓ Whether the command was applied successfully
error_message string Error message if the command failed
Constraints: default: ``
mode any Execution mode of the command
Constraints: default: production
commands_executed array of strings List of shell commands actually executed by the site agent

200 - No response body

Vmware

Vmware Clusters

Operations Summary

Method Endpoint Description
GET /api/vmware-clusters/ List Vmware Clusters
GET /api/vmware-clusters/{uuid}/ Retrieve

List Vmware Clusters

1
2
3
4
http \
  GET \
  https://api.example.com/api/vmware-clusters/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.vmware_clusters import vmware_clusters_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = vmware_clusters_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: vmware_clusters_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { vmwareClustersList } from 'waldur-js-client';

try {
  const response = await vmwareClustersList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
customer_uuid string (uuid) Customer UUID
name string Name
name_exact string Name (exact)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
settings string (uri) Settings URL
settings_uuid string (uuid) Settings UUID

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
url string (uri)
uuid string (uuid)
name string

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/vmware-clusters/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.vmware_clusters import vmware_clusters_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = vmware_clusters_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: vmware_clusters_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { vmwareClustersRetrieve } from 'waldur-js-client';

try {
  const response = await vmwareClustersRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
url string (uri)
uuid string (uuid)
name string

Vmware Datastores

Operations Summary

Method Endpoint Description
GET /api/vmware-datastores/ List Vmware Datastores
GET /api/vmware-datastores/{uuid}/ Retrieve

List Vmware Datastores

1
2
3
4
http \
  GET \
  https://api.example.com/api/vmware-datastores/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.vmware_datastores import vmware_datastores_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = vmware_datastores_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: vmware_datastores_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { vmwareDatastoresList } from 'waldur-js-client';

try {
  const response = await vmwareDatastoresList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
customer_uuid string (uuid) Customer UUID
name string Name
name_exact string Name (exact)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
settings string (uri) Settings URL
settings_uuid string (uuid) Settings UUID

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
name string
type string
capacity integer Capacity, in MB.
free_space integer Available space, in MB.

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/vmware-datastores/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.vmware_datastores import vmware_datastores_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = vmware_datastores_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: vmware_datastores_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { vmwareDatastoresRetrieve } from 'waldur-js-client';

try {
  const response = await vmwareDatastoresRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
type string
capacity integer Capacity, in MB.
free_space integer Available space, in MB.

Vmware Disks

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/vmware-disks/ List Vmware Disks
GET /api/vmware-disks/{uuid}/ Retrieve
POST /api/vmware-disks/{uuid}/pull/ Synchronize resource state
POST /api/vmware-disks/{uuid}/unlink/ Unlink resource
DELETE /api/vmware-disks/{uuid}/ Delete
Other Actions
POST /api/vmware-disks/{uuid}/extend/ Increase disk capacity
POST /api/vmware-disks/{uuid}/set_erred/ Mark resource as ERRED
POST /api/vmware-disks/{uuid}/set_ok/ Mark resource as OK

Core CRUD

List Vmware Disks

1
2
3
4
http \
  GET \
  https://api.example.com/api/vmware-disks/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.core_states import CoreStates # (1)
from waldur_api_client.models.vmware_disk_field_enum import VmwareDiskFieldEnum # (2)
from waldur_api_client.api.vmware_disks import vmware_disks_list # (3)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = vmware_disks_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: CoreStates
  2. Model Source: VmwareDiskFieldEnum
  3. API Source: vmware_disks_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { vmwareDisksList } from 'waldur-js-client';

try {
  const response = await vmwareDisksList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
backend_id string Backend ID
can_manage boolean Can manage
customer string (uuid) Customer UUID
customer_abbreviation string Customer abbreviation
customer_name string Customer name
customer_native_name string Customer native name
customer_uuid string (uuid) Customer UUID
description string Description
external_ip string External IP
field array
name string Name
name_exact string Name (exact)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
project string (uuid) Project UUID
project_name string Project name
project_uuid string (uuid) Project UUID
service_settings_name string Service settings name
service_settings_uuid string (uuid) Service settings UUID
state array State
uuid string (uuid) UUID
vm string (uri)
vm_uuid string (uuid)

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
size integer Size in MiB
vm string (uri)
vm_uuid string (uuid)
vm_name string
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/vmware-disks/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.vmware_disk_field_enum import VmwareDiskFieldEnum # (1)
from waldur_api_client.api.vmware_disks import vmware_disks_retrieve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = vmware_disks_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. Model Source: VmwareDiskFieldEnum
  2. API Source: vmware_disks_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { vmwareDisksRetrieve } from 'waldur-js-client';

try {
  const response = await vmwareDisksRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type
field array

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
size integer Size in MiB
vm string (uri)
vm_uuid string (uuid)
vm_name string
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Synchronize resource state

Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.

1
2
3
4
http \
  POST \
  https://api.example.com/api/vmware-disks/a1b2c3d4-e5f6-7890-abcd-ef1234567890/pull/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.vmware_disks import vmware_disks_pull # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = vmware_disks_pull.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: vmware_disks_pull
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { vmwareDisksPull } from 'waldur-js-client';

try {
  const response = await vmwareDisksPull({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

202 -

Field Type
detail string

409 -

Field Type
detail string

Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state.

1
2
3
4
http \
  POST \
  https://api.example.com/api/vmware-disks/a1b2c3d4-e5f6-7890-abcd-ef1234567890/unlink/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.vmware_disks import vmware_disks_unlink # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = vmware_disks_unlink.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: vmware_disks_unlink
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { vmwareDisksUnlink } from 'waldur-js-client';

try {
  const response = await vmwareDisksUnlink({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/vmware-disks/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.vmware_disks import vmware_disks_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = vmware_disks_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: vmware_disks_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { vmwareDisksDestroy } from 'waldur-js-client';

try {
  const response = await vmwareDisksDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Other Actions

Increase disk capacity

Increase disk capacity

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/vmware-disks/a1b2c3d4-e5f6-7890-abcd-ef1234567890/extend/ \
  Authorization:"Token YOUR_API_TOKEN" \
  size=100

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.vmware_disk_extend_request import VmwareDiskExtendRequest # (1)
from waldur_api_client.api.vmware_disks import vmware_disks_extend # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = VmwareDiskExtendRequest(
    size=100
)
response = vmware_disks_extend.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: VmwareDiskExtendRequest
  2. API Source: vmware_disks_extend
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { vmwareDisksExtend } from 'waldur-js-client';

try {
  const response = await vmwareDisksExtend({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "size": 100
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
size integer ✓ Size in MiB

200 -

Field Type Description
size integer Size in MiB

Mark resource as ERRED

Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.

1
2
3
4
http \
  POST \
  https://api.example.com/api/vmware-disks/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_erred/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.set_erred_request import SetErredRequest # (1)
from waldur_api_client.api.vmware_disks import vmware_disks_set_erred # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = SetErredRequest()
response = vmware_disks_set_erred.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: SetErredRequest
  2. API Source: vmware_disks_set_erred
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { vmwareDisksSetErred } from 'waldur-js-client';

try {
  const response = await vmwareDisksSetErred({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
error_message string
error_traceback string

200 -

Field Type
detail string

Mark resource as OK

Manually transition the resource to OK state and clear error fields. Staff-only operation.

1
2
3
4
http \
  POST \
  https://api.example.com/api/vmware-disks/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_ok/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.vmware_disks import vmware_disks_set_ok # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = vmware_disks_set_ok.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: vmware_disks_set_ok
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { vmwareDisksSetOk } from 'waldur-js-client';

try {
  const response = await vmwareDisksSetOk({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
detail string

Vmware Folders

Operations Summary

Method Endpoint Description
GET /api/vmware-folders/ List Vmware Folders
GET /api/vmware-folders/{uuid}/ Retrieve

List Vmware Folders

1
2
3
4
http \
  GET \
  https://api.example.com/api/vmware-folders/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.vmware_folders import vmware_folders_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = vmware_folders_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: vmware_folders_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { vmwareFoldersList } from 'waldur-js-client';

try {
  const response = await vmwareFoldersList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
customer_uuid string (uuid) Customer UUID
name string Name
name_exact string Name (exact)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
settings string (uri) Settings URL
settings_uuid string (uuid) Settings UUID

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
url string (uri)
uuid string (uuid)
name string

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/vmware-folders/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.vmware_folders import vmware_folders_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = vmware_folders_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: vmware_folders_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { vmwareFoldersRetrieve } from 'waldur-js-client';

try {
  const response = await vmwareFoldersRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
url string (uri)
uuid string (uuid)
name string

Vmware Limits

Operations Summary

Method Endpoint Description
GET /api/vmware-limits/{uuid}/ Retrieve

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/vmware-limits/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.vmware_limits import vmware_limits_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = vmware_limits_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: vmware_limits_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { vmwareLimitsRetrieve } from 'waldur-js-client';

try {
  const response = await vmwareLimitsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
max_cpu integer
max_cores_per_socket integer
max_ram integer
max_disk integer
max_disk_total integer

Vmware Networks

Operations Summary

Method Endpoint Description
GET /api/vmware-networks/ List Vmware Networks
GET /api/vmware-networks/{uuid}/ Retrieve

List Vmware Networks

1
2
3
4
http \
  GET \
  https://api.example.com/api/vmware-networks/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.vmware_networks import vmware_networks_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = vmware_networks_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: vmware_networks_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { vmwareNetworksList } from 'waldur-js-client';

try {
  const response = await vmwareNetworksList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
customer_pair_uuid string (uuid) Customer UUID
customer_uuid string (uuid) Customer UUID
name string Name
name_exact string Name (exact)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
settings string (uri) Settings URL
settings_uuid string (uuid) Settings UUID

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
url string (uri)
uuid string (uuid)
name string
type string

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/vmware-networks/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.vmware_networks import vmware_networks_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = vmware_networks_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: vmware_networks_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { vmwareNetworksRetrieve } from 'waldur-js-client';

try {
  const response = await vmwareNetworksRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
url string (uri)
uuid string (uuid)
name string
type string

Vmware Ports

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/vmware-ports/ List Vmware Ports
GET /api/vmware-ports/{uuid}/ Retrieve
POST /api/vmware-ports/{uuid}/pull/ Synchronize resource state
POST /api/vmware-ports/{uuid}/unlink/ Unlink resource
DELETE /api/vmware-ports/{uuid}/ Delete
Other Actions
POST /api/vmware-ports/{uuid}/set_erred/ Mark resource as ERRED
POST /api/vmware-ports/{uuid}/set_ok/ Mark resource as OK

Core CRUD

List Vmware Ports

1
2
3
4
http \
  GET \
  https://api.example.com/api/vmware-ports/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.core_states import CoreStates # (1)
from waldur_api_client.models.vmware_port_field_enum import VmwarePortFieldEnum # (2)
from waldur_api_client.api.vmware_ports import vmware_ports_list # (3)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = vmware_ports_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: CoreStates
  2. Model Source: VmwarePortFieldEnum
  3. API Source: vmware_ports_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { vmwarePortsList } from 'waldur-js-client';

try {
  const response = await vmwarePortsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
backend_id string Backend ID
can_manage boolean Can manage
customer string (uuid) Customer UUID
customer_abbreviation string Customer abbreviation
customer_name string Customer name
customer_native_name string Customer native name
customer_uuid string (uuid) Customer UUID
description string Description
external_ip string External IP
field array
name string Name
name_exact string Name (exact)
network string (uri)
network_uuid string (uuid)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
project string (uuid) Project UUID
project_name string Project name
project_uuid string (uuid) Project UUID
service_settings_name string Service settings name
service_settings_uuid string (uuid) Service settings UUID
state array State
uuid string (uuid) UUID
vm string (uri)
vm_uuid string (uuid)

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
mac_address string
vm string (uri)
vm_uuid string (uuid)
vm_name string
network string (uri)
network_name string
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/vmware-ports/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.vmware_port_field_enum import VmwarePortFieldEnum # (1)
from waldur_api_client.api.vmware_ports import vmware_ports_retrieve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = vmware_ports_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. Model Source: VmwarePortFieldEnum
  2. API Source: vmware_ports_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { vmwarePortsRetrieve } from 'waldur-js-client';

try {
  const response = await vmwarePortsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type
field array

200 -

Field Type
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
mac_address string
vm string (uri)
vm_uuid string (uuid)
vm_name string
network string (uri)
network_name string
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Synchronize resource state

Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.

1
2
3
4
http \
  POST \
  https://api.example.com/api/vmware-ports/a1b2c3d4-e5f6-7890-abcd-ef1234567890/pull/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.vmware_ports import vmware_ports_pull # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = vmware_ports_pull.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: vmware_ports_pull
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { vmwarePortsPull } from 'waldur-js-client';

try {
  const response = await vmwarePortsPull({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

202 -

Field Type
detail string

409 -

Field Type
detail string

Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state.

1
2
3
4
http \
  POST \
  https://api.example.com/api/vmware-ports/a1b2c3d4-e5f6-7890-abcd-ef1234567890/unlink/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.vmware_ports import vmware_ports_unlink # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = vmware_ports_unlink.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: vmware_ports_unlink
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { vmwarePortsUnlink } from 'waldur-js-client';

try {
  const response = await vmwarePortsUnlink({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/vmware-ports/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.vmware_ports import vmware_ports_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = vmware_ports_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: vmware_ports_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { vmwarePortsDestroy } from 'waldur-js-client';

try {
  const response = await vmwarePortsDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Other Actions

Mark resource as ERRED

Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.

1
2
3
4
http \
  POST \
  https://api.example.com/api/vmware-ports/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_erred/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.set_erred_request import SetErredRequest # (1)
from waldur_api_client.api.vmware_ports import vmware_ports_set_erred # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = SetErredRequest()
response = vmware_ports_set_erred.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: SetErredRequest
  2. API Source: vmware_ports_set_erred
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { vmwarePortsSetErred } from 'waldur-js-client';

try {
  const response = await vmwarePortsSetErred({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
error_message string
error_traceback string

200 -

Field Type
detail string

Mark resource as OK

Manually transition the resource to OK state and clear error fields. Staff-only operation.

1
2
3
4
http \
  POST \
  https://api.example.com/api/vmware-ports/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_ok/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.vmware_ports import vmware_ports_set_ok # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = vmware_ports_set_ok.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: vmware_ports_set_ok
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { vmwarePortsSetOk } from 'waldur-js-client';

try {
  const response = await vmwarePortsSetOk({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
detail string

Vmware Templates

Operations Summary

Method Endpoint Description
GET /api/vmware-templates/ List Vmware Templates
GET /api/vmware-templates/{uuid}/ Retrieve

List Vmware Templates

1
2
3
4
http \
  GET \
  https://api.example.com/api/vmware-templates/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.vmware_templates import vmware_templates_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = vmware_templates_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: vmware_templates_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { vmwareTemplatesList } from 'waldur-js-client';

try {
  const response = await vmwareTemplatesList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
name string Name
name_exact string Name (exact)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
settings string (uri) Settings URL
settings_uuid string (uuid) Settings UUID

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
created string (date-time)
modified string (date-time)
guest_os string Defines the valid guest operating system types used for configuring a virtual machine
guest_os_name string
cores integer Number of cores in a VM
cores_per_socket integer Number of cores per socket in a VM
ram integer Memory size in MiB
disk integer Disk size in MiB

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/vmware-templates/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.vmware_templates import vmware_templates_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = vmware_templates_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: vmware_templates_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { vmwareTemplatesRetrieve } from 'waldur-js-client';

try {
  const response = await vmwareTemplatesRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
created string (date-time)
modified string (date-time)
guest_os string Defines the valid guest operating system types used for configuring a virtual machine
guest_os_name string
cores integer Number of cores in a VM
cores_per_socket integer Number of cores per socket in a VM
ram integer Memory size in MiB
disk integer Disk size in MiB

Vmware Virtual Machine

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/vmware-virtual-machine/ List Vmware Virtual Machine
GET /api/vmware-virtual-machine/{uuid}/ Retrieve
POST /api/vmware-virtual-machine/ Create
POST /api/vmware-virtual-machine/{uuid}/create_disk/ Create disk
POST /api/vmware-virtual-machine/{uuid}/create_port/ Create port
POST /api/vmware-virtual-machine/{uuid}/pull/ Synchronize resource state
POST /api/vmware-virtual-machine/{uuid}/unlink/ Unlink resource
PUT /api/vmware-virtual-machine/{uuid}/ Update
PATCH /api/vmware-virtual-machine/{uuid}/ Partial Update
DELETE /api/vmware-virtual-machine/{uuid}/ Delete
Other Actions
GET /api/vmware-virtual-machine/{uuid}/console/ This endpoint provides access to Virtual Machine Remote Console aka VMRC
GET /api/vmware-virtual-machine/{uuid}/web_console/ This endpoint provides access to HTML Console aka WMKS
POST /api/vmware-virtual-machine/{uuid}/reboot_guest/ Reboot guest
POST /api/vmware-virtual-machine/{uuid}/reset/ Reset
POST /api/vmware-virtual-machine/{uuid}/set_erred/ Mark resource as ERRED
POST /api/vmware-virtual-machine/{uuid}/set_ok/ Mark resource as OK
POST /api/vmware-virtual-machine/{uuid}/shutdown_guest/ Shutdown guest
POST /api/vmware-virtual-machine/{uuid}/start/ Start
POST /api/vmware-virtual-machine/{uuid}/stop/ Stop
POST /api/vmware-virtual-machine/{uuid}/suspend/ Suspend

Core CRUD

List Vmware Virtual Machine

1
2
3
4
http \
  GET \
  https://api.example.com/api/vmware-virtual-machine/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.core_states import CoreStates # (1)
from waldur_api_client.models.vmware_virtual_machine_field_enum import VmwareVirtualMachineFieldEnum # (2)
from waldur_api_client.api.vmware_virtual_machine import vmware_virtual_machine_list # (3)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = vmware_virtual_machine_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: CoreStates
  2. Model Source: VmwareVirtualMachineFieldEnum
  3. API Source: vmware_virtual_machine_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { vmwareVirtualMachineList } from 'waldur-js-client';

try {
  const response = await vmwareVirtualMachineList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
backend_id string Backend ID
can_manage boolean Can manage
customer string (uuid) Customer UUID
customer_abbreviation string Customer abbreviation
customer_name string Customer name
customer_native_name string Customer native name
customer_uuid string (uuid) Customer UUID
description string Description
external_ip string External IP
field array
name string Name
name_exact string Name (exact)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
project string (uuid) Project UUID
project_name string Project name
project_uuid string (uuid) Project UUID
runtime_state string
service_settings_name string Service settings name
service_settings_uuid string (uuid) Service settings UUID
state array State
uuid string (uuid) UUID

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
guest_os any
guest_os_name string
cores integer Number of cores in a VM
cores_per_socket integer Number of cores per socket in a VM
ram integer Memory size in MiB
disk integer Disk size in MiB
disks array of objects
disks.url string (uri)
disks.uuid string (uuid)
disks.size integer Size in MiB
runtime_state string
cluster string (uri)
datastore string (uri)
folder string (uri)
template_name string
cluster_name string
datastore_name string
folder_name string
ports array of objects
ports.url string (uri)
ports.uuid string (uuid)
ports.name string
ports.mac_address string
ports.network string (uri)
guest_power_state any
tools_state string
tools_installed boolean
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/vmware-virtual-machine/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.vmware_virtual_machine_field_enum import VmwareVirtualMachineFieldEnum # (1)
from waldur_api_client.api.vmware_virtual_machine import vmware_virtual_machine_retrieve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = vmware_virtual_machine_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. Model Source: VmwareVirtualMachineFieldEnum
  2. API Source: vmware_virtual_machine_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { vmwareVirtualMachineRetrieve } from 'waldur-js-client';

try {
  const response = await vmwareVirtualMachineRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type
field array

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
guest_os any
guest_os_name string
cores integer Number of cores in a VM
cores_per_socket integer Number of cores per socket in a VM
ram integer Memory size in MiB
disk integer Disk size in MiB
disks array of objects
disks.url string (uri)
disks.uuid string (uuid)
disks.size integer Size in MiB
runtime_state string
cluster string (uri)
datastore string (uri)
folder string (uri)
template_name string
cluster_name string
datastore_name string
folder_name string
ports array of objects
ports.url string (uri)
ports.uuid string (uuid)
ports.name string
ports.mac_address string
ports.network string (uri)
guest_power_state any
tools_state string
tools_installed boolean
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Create

1
2
3
4
5
6
7
http \
  POST \
  https://api.example.com/api/vmware-virtual-machine/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-vmware-virtual-machine" \
  service_settings="https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.vmware_virtual_machine_request import VmwareVirtualMachineRequest # (1)
from waldur_api_client.api.vmware_virtual_machine import vmware_virtual_machine_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = VmwareVirtualMachineRequest(
    name="my-awesome-vmware-virtual-machine",
    service_settings="https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = vmware_virtual_machine_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: VmwareVirtualMachineRequest
  2. API Source: vmware_virtual_machine_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
import { vmwareVirtualMachineCreate } from 'waldur-js-client';

try {
  const response = await vmwareVirtualMachineCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "name": "my-awesome-vmware-virtual-machine",
    "service_settings": "https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "project": "https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
name string ✓
description string
service_settings string (uri) ✓
project string (uri) ✓
guest_os any
cores integer Number of cores in a VM
cores_per_socket integer Number of cores per socket in a VM
ram integer Memory size in MiB
template string (uri)
Constraints: write-only
cluster string (uri)
networks array of objects
Constraints: write-only
networks.url string (uri) ✓
datastore string (uri)
folder string (uri)

201 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
guest_os any
guest_os_name string
cores integer Number of cores in a VM
cores_per_socket integer Number of cores per socket in a VM
ram integer Memory size in MiB
disk integer Disk size in MiB
disks array of objects
disks.url string (uri)
disks.uuid string (uuid)
disks.size integer Size in MiB
runtime_state string
cluster string (uri)
datastore string (uri)
folder string (uri)
template_name string
cluster_name string
datastore_name string
folder_name string
ports array of objects
ports.url string (uri)
ports.uuid string (uuid)
ports.name string
ports.mac_address string
ports.network string (uri)
guest_power_state any
tools_state string
tools_installed boolean
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Create disk

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/vmware-virtual-machine/a1b2c3d4-e5f6-7890-abcd-ef1234567890/create_disk/ \
  Authorization:"Token YOUR_API_TOKEN" \
  size=100

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.vmware_disk_request import VmwareDiskRequest # (1)
from waldur_api_client.api.vmware_virtual_machine import vmware_virtual_machine_create_disk # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = VmwareDiskRequest(
    size=100
)
response = vmware_virtual_machine_create_disk.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: VmwareDiskRequest
  2. API Source: vmware_virtual_machine_create_disk
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { vmwareVirtualMachineCreateDisk } from 'waldur-js-client';

try {
  const response = await vmwareVirtualMachineCreateDisk({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "size": 100
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
description string
size integer ✓ Size in MiB

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
size integer Size in MiB
vm string (uri)
vm_uuid string (uuid)
vm_name string
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Create port

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/vmware-virtual-machine/a1b2c3d4-e5f6-7890-abcd-ef1234567890/create_port/ \
  Authorization:"Token YOUR_API_TOKEN" \
  network="https://api.example.com/api/network/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.vmware_port_request import VmwarePortRequest # (1)
from waldur_api_client.api.vmware_virtual_machine import vmware_virtual_machine_create_port # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = VmwarePortRequest(
    network="https://api.example.com/api/network/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = vmware_virtual_machine_create_port.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: VmwarePortRequest
  2. API Source: vmware_virtual_machine_create_port
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { vmwareVirtualMachineCreatePort } from 'waldur-js-client';

try {
  const response = await vmwareVirtualMachineCreatePort({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "network": "https://api.example.com/api/network/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
description string
network string (uri) ✓

200 -

Field Type
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
mac_address string
vm string (uri)
vm_uuid string (uuid)
vm_name string
network string (uri)
network_name string
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Synchronize resource state

Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.

1
2
3
4
http \
  POST \
  https://api.example.com/api/vmware-virtual-machine/a1b2c3d4-e5f6-7890-abcd-ef1234567890/pull/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.vmware_virtual_machine import vmware_virtual_machine_pull # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = vmware_virtual_machine_pull.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: vmware_virtual_machine_pull
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { vmwareVirtualMachinePull } from 'waldur-js-client';

try {
  const response = await vmwareVirtualMachinePull({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

202 -

Field Type
detail string

409 -

Field Type
detail string

Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state.

1
2
3
4
http \
  POST \
  https://api.example.com/api/vmware-virtual-machine/a1b2c3d4-e5f6-7890-abcd-ef1234567890/unlink/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.vmware_virtual_machine import vmware_virtual_machine_unlink # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = vmware_virtual_machine_unlink.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: vmware_virtual_machine_unlink
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { vmwareVirtualMachineUnlink } from 'waldur-js-client';

try {
  const response = await vmwareVirtualMachineUnlink({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Update

1
2
3
4
5
6
7
http \
  PUT \
  https://api.example.com/api/vmware-virtual-machine/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-vmware-virtual-machine" \
  service_settings="https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.vmware_virtual_machine_request import VmwareVirtualMachineRequest # (1)
from waldur_api_client.api.vmware_virtual_machine import vmware_virtual_machine_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = VmwareVirtualMachineRequest(
    name="my-awesome-vmware-virtual-machine",
    service_settings="https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = vmware_virtual_machine_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: VmwareVirtualMachineRequest
  2. API Source: vmware_virtual_machine_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
import { vmwareVirtualMachineUpdate } from 'waldur-js-client';

try {
  const response = await vmwareVirtualMachineUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-vmware-virtual-machine",
    "service_settings": "https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "project": "https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
name string ✓
description string
service_settings string (uri) ✓
project string (uri) ✓
guest_os any
cores integer Number of cores in a VM
cores_per_socket integer Number of cores per socket in a VM
ram integer Memory size in MiB
template string (uri)
Constraints: write-only
cluster string (uri)
networks array of objects
Constraints: write-only
networks.url string (uri) ✓
datastore string (uri)
folder string (uri)

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
guest_os any
guest_os_name string
cores integer Number of cores in a VM
cores_per_socket integer Number of cores per socket in a VM
ram integer Memory size in MiB
disk integer Disk size in MiB
disks array of objects
disks.url string (uri)
disks.uuid string (uuid)
disks.size integer Size in MiB
runtime_state string
cluster string (uri)
datastore string (uri)
folder string (uri)
template_name string
cluster_name string
datastore_name string
folder_name string
ports array of objects
ports.url string (uri)
ports.uuid string (uuid)
ports.name string
ports.mac_address string
ports.network string (uri)
guest_power_state any
tools_state string
tools_installed boolean
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/vmware-virtual-machine/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_vmware_virtual_machine_request import PatchedVmwareVirtualMachineRequest # (1)
from waldur_api_client.api.vmware_virtual_machine import vmware_virtual_machine_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedVmwareVirtualMachineRequest()
response = vmware_virtual_machine_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedVmwareVirtualMachineRequest
  2. API Source: vmware_virtual_machine_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { vmwareVirtualMachinePartialUpdate } from 'waldur-js-client';

try {
  const response = await vmwareVirtualMachinePartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
description string
cores integer Number of cores in a VM
cores_per_socket integer Number of cores per socket in a VM
ram integer Memory size in MiB

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string
access_url string
guest_os any
guest_os_name string
cores integer Number of cores in a VM
cores_per_socket integer Number of cores per socket in a VM
ram integer Memory size in MiB
disk integer Disk size in MiB
disks array of objects
disks.url string (uri)
disks.uuid string (uuid)
disks.size integer Size in MiB
runtime_state string
cluster string (uri)
datastore string (uri)
folder string (uri)
template_name string
cluster_name string
datastore_name string
folder_name string
ports array of objects
ports.url string (uri)
ports.uuid string (uuid)
ports.name string
ports.mac_address string
ports.network string (uri)
guest_power_state any
tools_state string
tools_installed boolean
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/vmware-virtual-machine/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.vmware_virtual_machine import vmware_virtual_machine_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = vmware_virtual_machine_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: vmware_virtual_machine_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { vmwareVirtualMachineDestroy } from 'waldur-js-client';

try {
  const response = await vmwareVirtualMachineDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Other Actions

This endpoint provides access to Virtual Machine Remote Console aka VMRC

This endpoint provides access to Virtual Machine Remote Console aka VMRC.

1
2
3
4
http \
  GET \
  https://api.example.com/api/vmware-virtual-machine/a1b2c3d4-e5f6-7890-abcd-ef1234567890/console/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.vmware_virtual_machine import vmware_virtual_machine_console_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = vmware_virtual_machine_console_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: vmware_virtual_machine_console_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { vmwareVirtualMachineConsoleRetrieve } from 'waldur-js-client';

try {
  const response = await vmwareVirtualMachineConsoleRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
url string (uri)

This endpoint provides access to HTML Console aka WMKS

This endpoint provides access to HTML Console aka WMKS.

1
2
3
4
http \
  GET \
  https://api.example.com/api/vmware-virtual-machine/a1b2c3d4-e5f6-7890-abcd-ef1234567890/web_console/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.vmware_virtual_machine import vmware_virtual_machine_web_console_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = vmware_virtual_machine_web_console_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: vmware_virtual_machine_web_console_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { vmwareVirtualMachineWebConsoleRetrieve } from 'waldur-js-client';

try {
  const response = await vmwareVirtualMachineWebConsoleRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
url string (uri)

Reboot guest

1
2
3
4
http \
  POST \
  https://api.example.com/api/vmware-virtual-machine/a1b2c3d4-e5f6-7890-abcd-ef1234567890/reboot_guest/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.vmware_virtual_machine import vmware_virtual_machine_reboot_guest # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = vmware_virtual_machine_reboot_guest.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: vmware_virtual_machine_reboot_guest
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { vmwareVirtualMachineRebootGuest } from 'waldur-js-client';

try {
  const response = await vmwareVirtualMachineRebootGuest({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 - No response body

Reset

1
2
3
4
http \
  POST \
  https://api.example.com/api/vmware-virtual-machine/a1b2c3d4-e5f6-7890-abcd-ef1234567890/reset/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.vmware_virtual_machine import vmware_virtual_machine_reset # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = vmware_virtual_machine_reset.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: vmware_virtual_machine_reset
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { vmwareVirtualMachineReset } from 'waldur-js-client';

try {
  const response = await vmwareVirtualMachineReset({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 - No response body

Mark resource as ERRED

Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.

1
2
3
4
http \
  POST \
  https://api.example.com/api/vmware-virtual-machine/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_erred/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.set_erred_request import SetErredRequest # (1)
from waldur_api_client.api.vmware_virtual_machine import vmware_virtual_machine_set_erred # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = SetErredRequest()
response = vmware_virtual_machine_set_erred.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: SetErredRequest
  2. API Source: vmware_virtual_machine_set_erred
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { vmwareVirtualMachineSetErred } from 'waldur-js-client';

try {
  const response = await vmwareVirtualMachineSetErred({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
error_message string
error_traceback string

200 -

Field Type
detail string

Mark resource as OK

Manually transition the resource to OK state and clear error fields. Staff-only operation.

1
2
3
4
http \
  POST \
  https://api.example.com/api/vmware-virtual-machine/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_ok/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.vmware_virtual_machine import vmware_virtual_machine_set_ok # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = vmware_virtual_machine_set_ok.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: vmware_virtual_machine_set_ok
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { vmwareVirtualMachineSetOk } from 'waldur-js-client';

try {
  const response = await vmwareVirtualMachineSetOk({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
detail string

Shutdown guest

1
2
3
4
http \
  POST \
  https://api.example.com/api/vmware-virtual-machine/a1b2c3d4-e5f6-7890-abcd-ef1234567890/shutdown_guest/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.vmware_virtual_machine import vmware_virtual_machine_shutdown_guest # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = vmware_virtual_machine_shutdown_guest.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: vmware_virtual_machine_shutdown_guest
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { vmwareVirtualMachineShutdownGuest } from 'waldur-js-client';

try {
  const response = await vmwareVirtualMachineShutdownGuest({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 - No response body

Start

1
2
3
4
http \
  POST \
  https://api.example.com/api/vmware-virtual-machine/a1b2c3d4-e5f6-7890-abcd-ef1234567890/start/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.vmware_virtual_machine import vmware_virtual_machine_start # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = vmware_virtual_machine_start.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: vmware_virtual_machine_start
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { vmwareVirtualMachineStart } from 'waldur-js-client';

try {
  const response = await vmwareVirtualMachineStart({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 - No response body

Stop

1
2
3
4
http \
  POST \
  https://api.example.com/api/vmware-virtual-machine/a1b2c3d4-e5f6-7890-abcd-ef1234567890/stop/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.vmware_virtual_machine import vmware_virtual_machine_stop # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = vmware_virtual_machine_stop.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: vmware_virtual_machine_stop
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { vmwareVirtualMachineStop } from 'waldur-js-client';

try {
  const response = await vmwareVirtualMachineStop({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 - No response body

Suspend

1
2
3
4
http \
  POST \
  https://api.example.com/api/vmware-virtual-machine/a1b2c3d4-e5f6-7890-abcd-ef1234567890/suspend/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.vmware_virtual_machine import vmware_virtual_machine_suspend # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = vmware_virtual_machine_suspend.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: vmware_virtual_machine_suspend
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { vmwareVirtualMachineSuspend } from 'waldur-js-client';

try {
  const response = await vmwareVirtualMachineSuspend({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 - No response body

Core

Identity management and access policy

Access Subnets

Operations Summary

Method Endpoint Description
GET /api/access-subnets/ List access subnets
GET /api/access-subnets/{uuid}/ Retrieve access subnet
POST /api/access-subnets/ Create an access subnet
PUT /api/access-subnets/{uuid}/ Update an access subnet
PATCH /api/access-subnets/{uuid}/ Partially update an access subnet
DELETE /api/access-subnets/{uuid}/ Delete an access subnet

List access subnets

Retrieve a list of access subnets. Staff and support users can see all subnets, while other users can only see subnets associated with customers they have a role in.

1
2
3
4
http \
  GET \
  https://api.example.com/api/access-subnets/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.access_subnets import access_subnets_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = access_subnets_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: access_subnets_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { accessSubnetsList } from 'waldur-js-client';

try {
  const response = await accessSubnetsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
customer string (uri) Customer URL
customer_uuid string (uuid) Customer UUID
description string Description
inet string Inet
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
uuid string (uuid)
inet string
description string
customer string (uri)

Retrieve access subnet

Fetch the details of a specific access subnet by its UUID.

1
2
3
4
http \
  GET \
  https://api.example.com/api/access-subnets/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.access_subnets import access_subnets_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = access_subnets_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: access_subnets_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { accessSubnetsRetrieve } from 'waldur-js-client';

try {
  const response = await accessSubnetsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
uuid string (uuid)
inet string
description string
customer string (uri)

Create an access subnet

Create a new access subnet for a customer.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/access-subnets/ \
  Authorization:"Token YOUR_API_TOKEN" \
  inet="string-value" \
  customer="https://api.example.com/api/customer/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.access_subnet_request import AccessSubnetRequest # (1)
from waldur_api_client.api.access_subnets import access_subnets_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = AccessSubnetRequest(
    inet="string-value",
    customer="https://api.example.com/api/customer/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = access_subnets_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: AccessSubnetRequest
  2. API Source: access_subnets_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { accessSubnetsCreate } from 'waldur-js-client';

try {
  const response = await accessSubnetsCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "inet": "string-value",
    "customer": "https://api.example.com/api/customer/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required
inet string ✓
description string
customer string (uri) ✓

201 -

Field Type
uuid string (uuid)
inet string
description string
customer string (uri)

Update an access subnet

Update an existing access subnet.

1
2
3
4
5
6
http \
  PUT \
  https://api.example.com/api/access-subnets/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  inet="string-value" \
  customer="https://api.example.com/api/customer/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.access_subnet_request import AccessSubnetRequest # (1)
from waldur_api_client.api.access_subnets import access_subnets_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = AccessSubnetRequest(
    inet="string-value",
    customer="https://api.example.com/api/customer/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = access_subnets_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: AccessSubnetRequest
  2. API Source: access_subnets_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { accessSubnetsUpdate } from 'waldur-js-client';

try {
  const response = await accessSubnetsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "inet": "string-value",
    "customer": "https://api.example.com/api/customer/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
inet string ✓
description string
customer string (uri) ✓

200 -

Field Type
uuid string (uuid)
inet string
description string
customer string (uri)

Partially update an access subnet

Partially update an existing access subnet.

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/access-subnets/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_access_subnet_request import PatchedAccessSubnetRequest # (1)
from waldur_api_client.api.access_subnets import access_subnets_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedAccessSubnetRequest()
response = access_subnets_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedAccessSubnetRequest
  2. API Source: access_subnets_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { accessSubnetsPartialUpdate } from 'waldur-js-client';

try {
  const response = await accessSubnetsPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
inet string
description string

200 -

Field Type
uuid string (uuid)
inet string
description string
customer string (uri)

Delete an access subnet

Delete an existing access subnet.

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/access-subnets/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.access_subnets import access_subnets_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = access_subnets_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: access_subnets_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { accessSubnetsDestroy } from 'waldur-js-client';

try {
  const response = await accessSubnetsDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Auth Tokens

Operations Summary

Method Endpoint Description
GET /api/auth-tokens/ List Auth Tokens
GET /api/auth-tokens/{user_id}/ Retrieve
DELETE /api/auth-tokens/{user_id}/ Delete

List Auth Tokens

1
2
3
4
http \
  GET \
  https://api.example.com/api/auth-tokens/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.auth_tokens import auth_tokens_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = auth_tokens_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: auth_tokens_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { authTokensList } from 'waldur-js-client';

try {
  const response = await authTokensList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
created string (date-time)
user string (uri)
user_first_name string
user_last_name string
user_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
user_is_active boolean Designates whether this user should be treated as active. Unselect this instead of deleting accounts.
user_token_lifetime integer Token lifetime in seconds.

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/auth-tokens/123/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.auth_tokens import auth_tokens_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = auth_tokens_retrieve.sync(
    user_id=123,
    client=client
)

print(response)
  1. API Source: auth_tokens_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { authTokensRetrieve } from 'waldur-js-client';

try {
  const response = await authTokensRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "user_id": 123
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
user_id integer ✓

200 -

Field Type Description
url string (uri)
created string (date-time)
user string (uri)
user_first_name string
user_last_name string
user_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
user_is_active boolean Designates whether this user should be treated as active. Unselect this instead of deleting accounts.
user_token_lifetime integer Token lifetime in seconds.

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/auth-tokens/123/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.auth_tokens import auth_tokens_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = auth_tokens_destroy.sync(
    user_id=123,
    client=client
)

print(response)
  1. API Source: auth_tokens_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { authTokensDestroy } from 'waldur-js-client';

try {
  const response = await authTokensDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "user_id": 123
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
user_id integer ✓

204 - No response body

Auth Valimo

Operations Summary

Method Endpoint Description
Core CRUD
POST /api/auth-valimo/ Create
Other Actions
POST /api/auth-valimo/result/ Result

Core CRUD

Create

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/auth-valimo/ \
  Authorization:"Token YOUR_API_TOKEN" \
  phone="+1-202-555-0104"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.auth_result_request import AuthResultRequest # (1)
from waldur_api_client.api.auth_valimo import auth_valimo_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = AuthResultRequest(
    phone="+1-202-555-0104"
)
response = auth_valimo_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: AuthResultRequest
  2. API Source: auth_valimo_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { authValimoCreate } from 'waldur-js-client';

try {
  const response = await authValimoCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "phone": "+1-202-555-0104"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required
phone string ✓

201 -

Field Type Description
uuid string (uuid)
token string
phone string
message string This message will be shown to user.
state any
error_message string
details string Cancellation details.

Other Actions

Result

1
2
3
4
5
6
7
8
9
    To get PKI login status and details - issue post request against /api/auth-valimo/result/
    with uuid in parameters.

    Possible states:
     - Scheduled - login process is scheduled
     - Processing - login is in progress
     - OK - login was successful. Response will contain token.
     - Canceled - login was canceled by user or timed out. Field details will contain additional info.
     - Erred - unexpected exception happened during login process.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/auth-valimo/result/ \
  Authorization:"Token YOUR_API_TOKEN" \
  uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.auth_result_uuid_request import AuthResultUUIDRequest # (1)
from waldur_api_client.api.auth_valimo import auth_valimo_result # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = AuthResultUUIDRequest(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
)
response = auth_valimo_result.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: AuthResultUUIDRequest
  2. API Source: auth_valimo_result
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { authValimoResult } from 'waldur-js-client';

try {
  const response = await authValimoResult({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
uuid string (uuid) ✓ UUID of the authentication result.

200 -

Field Type Description
uuid string (uuid)
token string
phone string
message string This message will be shown to user.
state any
error_message string
details string Cancellation details.

Freeipa Profiles

Operations Summary

Method Endpoint Description
GET /api/freeipa-profiles/ List Freeipa Profiles
GET /api/freeipa-profiles/{uuid}/ Retrieve
POST /api/freeipa-profiles/ Create
POST /api/freeipa-profiles/{uuid}/update_ssh_keys/ Update SSH keys for profile
PUT /api/freeipa-profiles/{uuid}/ Update
PATCH /api/freeipa-profiles/{uuid}/ Partial Update

List Freeipa Profiles

1
2
3
4
http \
  GET \
  https://api.example.com/api/freeipa-profiles/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.freeipa_profiles import freeipa_profiles_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = freeipa_profiles_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: freeipa_profiles_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { freeipaProfilesList } from 'waldur-js-client';

try {
  const response = await freeipaProfilesList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
query string Filter by username, user UUID, first name or last name
user string (uuid)

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid)
username string Letters, numbers and ./+/-/_ characters
agreement_date string (date-time) Indicates when the user has agreed with the policy.
is_active boolean
user string (uri)
user_uuid string (uuid)
user_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
user_full_name string

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/freeipa-profiles/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.freeipa_profiles import freeipa_profiles_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = freeipa_profiles_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: freeipa_profiles_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { freeipaProfilesRetrieve } from 'waldur-js-client';

try {
  const response = await freeipaProfilesRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
uuid string (uuid)
username string Letters, numbers and ./+/-/_ characters
agreement_date string (date-time) Indicates when the user has agreed with the policy.
is_active boolean
user string (uri)
user_uuid string (uuid)
user_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
user_full_name string

Create

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/freeipa-profiles/ \
  Authorization:"Token YOUR_API_TOKEN" \
  username="alice"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.freeipa_profile_request import FreeipaProfileRequest # (1)
from waldur_api_client.api.freeipa_profiles import freeipa_profiles_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = FreeipaProfileRequest(
    username="alice"
)
response = freeipa_profiles_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: FreeipaProfileRequest
  2. API Source: freeipa_profiles_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { freeipaProfilesCreate } from 'waldur-js-client';

try {
  const response = await freeipaProfilesCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "username": "alice"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
username string ✓ Letters, numbers and ./+/-/_ characters
agreement_date string (date-time) Indicates when the user has agreed with the policy.

201 -

Field Type Description
uuid string (uuid)
username string Letters, numbers and ./+/-/_ characters
agreement_date string (date-time) Indicates when the user has agreed with the policy.
is_active boolean
user string (uri)
user_uuid string (uuid)
user_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
user_full_name string

Update SSH keys for profile

Update SSH keys for profile.

1
2
3
4
http \
  POST \
  https://api.example.com/api/freeipa-profiles/a1b2c3d4-e5f6-7890-abcd-ef1234567890/update_ssh_keys/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.freeipa_profiles import freeipa_profiles_update_ssh_keys # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = freeipa_profiles_update_ssh_keys.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: freeipa_profiles_update_ssh_keys
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { freeipaProfilesUpdateSshKeys } from 'waldur-js-client';

try {
  const response = await freeipaProfilesUpdateSshKeys({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 - No response body

Update

1
2
3
4
5
http \
  PUT \
  https://api.example.com/api/freeipa-profiles/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  username="alice"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.freeipa_profile_request import FreeipaProfileRequest # (1)
from waldur_api_client.api.freeipa_profiles import freeipa_profiles_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = FreeipaProfileRequest(
    username="alice"
)
response = freeipa_profiles_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: FreeipaProfileRequest
  2. API Source: freeipa_profiles_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { freeipaProfilesUpdate } from 'waldur-js-client';

try {
  const response = await freeipaProfilesUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "username": "alice"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
username string ✓ Letters, numbers and ./+/-/_ characters
agreement_date string (date-time) Indicates when the user has agreed with the policy.

200 -

Field Type Description
uuid string (uuid)
username string Letters, numbers and ./+/-/_ characters
agreement_date string (date-time) Indicates when the user has agreed with the policy.
is_active boolean
user string (uri)
user_uuid string (uuid)
user_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
user_full_name string

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/freeipa-profiles/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.freeipa_profiles import freeipa_profiles_partial_update # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = freeipa_profiles_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: freeipa_profiles_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { freeipaProfilesPartialUpdate } from 'waldur-js-client';

try {
  const response = await freeipaProfilesPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
uuid string (uuid)
username string Letters, numbers and ./+/-/_ characters
agreement_date string (date-time) Indicates when the user has agreed with the policy.
is_active boolean
user string (uri)
user_uuid string (uuid)
user_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
user_full_name string

Google Auth

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/google-auth/ List Google Auth
GET /api/google-auth/{uuid}/ Retrieve
Other Actions
GET /api/google-auth/{uuid}/authorize/ Authorize
GET /api/google-auth/callback/ Callback endpoint for Google authorization

Core CRUD

List Google Auth

1
2
3
4
http \
  GET \
  https://api.example.com/api/google-auth/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.google_credentials_field_enum import GoogleCredentialsFieldEnum # (1)
from waldur_api_client.api.google_auth import google_auth_list # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = google_auth_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: GoogleCredentialsFieldEnum
  2. API Source: google_auth_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { googleAuthList } from 'waldur-js-client';

try {
  const response = await googleAuthList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
field array
has_credentials boolean has_credentials
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
created string (date-time)
description string
enable_notifications boolean
customer string (uri)
customer_name string
customer_uuid string (uuid)
customer_image string (uri)
customer_abbreviation string
customer_slug string
customer_native_name string
customer_country string
image string (uri)
organization_groups array of objects
organization_groups.uuid string (uuid)
organization_groups.url string (uri)
organization_groups.name string
organization_groups.parent_uuid string (uuid) UUID of the parent organization group
organization_groups.parent_name string Name of the parent organization group
organization_groups.parent string (uri)
organization_groups.customers_count integer Number of customers in this organization group
offering_count integer
calendar_token string
calendar_refresh_token string
google_auth_url string

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/google-auth/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.google_credentials_field_enum import GoogleCredentialsFieldEnum # (1)
from waldur_api_client.api.google_auth import google_auth_retrieve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = google_auth_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. Model Source: GoogleCredentialsFieldEnum
  2. API Source: google_auth_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { googleAuthRetrieve } from 'waldur-js-client';

try {
  const response = await googleAuthRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type
field array

200 -

Field Type Description
url string (uri)
uuid string (uuid)
created string (date-time)
description string
enable_notifications boolean
customer string (uri)
customer_name string
customer_uuid string (uuid)
customer_image string (uri)
customer_abbreviation string
customer_slug string
customer_native_name string
customer_country string
image string (uri)
organization_groups array of objects
organization_groups.uuid string (uuid)
organization_groups.url string (uri)
organization_groups.name string
organization_groups.parent_uuid string (uuid) UUID of the parent organization group
organization_groups.parent_name string Name of the parent organization group
organization_groups.parent string (uri)
organization_groups.customers_count integer Number of customers in this organization group
offering_count integer
calendar_token string
calendar_refresh_token string
google_auth_url string

Other Actions

Authorize

1
2
3
4
http \
  GET \
  https://api.example.com/api/google-auth/a1b2c3d4-e5f6-7890-abcd-ef1234567890/authorize/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.google_credentials_field_enum import GoogleCredentialsFieldEnum # (1)
from waldur_api_client.api.google_auth import google_auth_authorize_retrieve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = google_auth_authorize_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. Model Source: GoogleCredentialsFieldEnum
  2. API Source: google_auth_authorize_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { googleAuthAuthorizeRetrieve } from 'waldur-js-client';

try {
  const response = await googleAuthAuthorizeRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type
field array

200 -

Field Type Description
url string (uri)
uuid string (uuid)
created string (date-time)
description string
enable_notifications boolean
customer string (uri)
customer_name string
customer_uuid string (uuid)
customer_image string (uri)
customer_abbreviation string
customer_slug string
customer_native_name string
customer_country string
image string (uri)
organization_groups array of objects
organization_groups.uuid string (uuid)
organization_groups.url string (uri)
organization_groups.name string
organization_groups.parent_uuid string (uuid) UUID of the parent organization group
organization_groups.parent_name string Name of the parent organization group
organization_groups.parent string (uri)
organization_groups.customers_count integer Number of customers in this organization group
offering_count integer
calendar_token string
calendar_refresh_token string
google_auth_url string

Callback endpoint for Google authorization

Callback endpoint for Google authorization.

1
2
3
4
5
6
http \
  GET \
  https://api.example.com/api/google-auth/callback/ \
  Authorization:"Token YOUR_API_TOKEN" \
  code=="string-value" \
  state=="OK"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.google_auth import google_auth_callback_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = google_auth_callback_retrieve.sync(
    client=client,
    code="string-value",
    state="OK"
)

print(response)
  1. API Source: google_auth_callback_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { googleAuthCallbackRetrieve } from 'waldur-js-client';

try {
  const response = await googleAuthCallbackRetrieve({
  auth: "Token YOUR_API_TOKEN",
  query: {
    "code": "string-value",
    "state": "OK"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
code string ✓ Authorization code
state string ✓ Service provider UUID

200 - No response body

Identity Providers

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/identity-providers/ List Identity Providers
GET /api/identity-providers/{provider}/ Retrieve
POST /api/identity-providers/ Create
PUT /api/identity-providers/{provider}/ Update
PATCH /api/identity-providers/{provider}/ Partial Update
DELETE /api/identity-providers/{provider}/ Delete
Other Actions
POST /api/identity-providers/discover_metadata/ Discover OIDC provider metadata
POST /api/identity-providers/generate-mapping/ Generate default attribute mapping

Core CRUD

List Identity Providers

1
2
3
4
http \
  GET \
  https://api.example.com/api/identity-providers/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.identity_providers import identity_providers_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = identity_providers_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: identity_providers_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { identityProvidersList } from 'waldur-js-client';

try {
  const response = await identityProvidersList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
provider string
is_active boolean
client_id string ID of application used for OAuth authentication.
client_secret string Application secret key.
verify_ssl boolean
enable_post_logout_redirect boolean
enable_pkce boolean
discovery_url string The endpoint for endpoint discovery.
userinfo_url string The endpoint for fetching user info.
token_url string The endpoint for obtaining auth token.
auth_url string The endpoint for authorization request flow.
logout_url string The endpoint used to redirect after sign-out.
label string Human-readable identity provider is label.
management_url string The endpoint for user details management.
protected_fields any
extra_scope string Space-separated list of scopes to request during authentication.
user_field string The field in Waldur User model to be used for looking up the user
user_claim string The OIDC claim from the userinfo endpoint to be used as the value for the lookup field.
attribute_mapping any A JSON object mapping Waldur User model fields to OIDC claims. Example:
extra_fields string Space-separated list of extra fields to persist.
allowed_redirects any List of allowed redirect URLs for OAuth authentication. URLs must be exact matches (origin only: scheme + domain + port). HTTPS required except for localhost. No wildcards, paths, query params, or fragments. Example: ["https://portal1.example.com", "https://portal2.example.com:8443"]. If empty, falls back to HOMEPORT_URL setting.

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/identity-providers/string-value/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.identity_providers import identity_providers_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = identity_providers_retrieve.sync(
    provider="string-value",
    client=client
)

print(response)
  1. API Source: identity_providers_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { identityProvidersRetrieve } from 'waldur-js-client';

try {
  const response = await identityProvidersRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "provider": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
provider string ✓

200 -

Field Type Description
provider string
is_active boolean
client_id string ID of application used for OAuth authentication.
client_secret string Application secret key.
verify_ssl boolean
enable_post_logout_redirect boolean
enable_pkce boolean
discovery_url string The endpoint for endpoint discovery.
userinfo_url string The endpoint for fetching user info.
token_url string The endpoint for obtaining auth token.
auth_url string The endpoint for authorization request flow.
logout_url string The endpoint used to redirect after sign-out.
label string Human-readable identity provider is label.
management_url string The endpoint for user details management.
protected_fields any
extra_scope string Space-separated list of scopes to request during authentication.
user_field string The field in Waldur User model to be used for looking up the user
user_claim string The OIDC claim from the userinfo endpoint to be used as the value for the lookup field.
attribute_mapping any A JSON object mapping Waldur User model fields to OIDC claims. Example:
extra_fields string Space-separated list of extra fields to persist.
allowed_redirects any List of allowed redirect URLs for OAuth authentication. URLs must be exact matches (origin only: scheme + domain + port). HTTPS required except for localhost. No wildcards, paths, query params, or fragments. Example: ["https://portal1.example.com", "https://portal2.example.com:8443"]. If empty, falls back to HOMEPORT_URL setting.

Create

1
2
3
4
5
6
7
8
9
http \
  POST \
  https://api.example.com/api/identity-providers/ \
  Authorization:"Token YOUR_API_TOKEN" \
  provider="string-value" \
  client_id="string-value" \
  client_secret="********" \
  discovery_url="string-value" \
  label="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.identity_provider_request import IdentityProviderRequest # (1)
from waldur_api_client.api.identity_providers import identity_providers_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = IdentityProviderRequest(
    provider="string-value",
    client_id="string-value",
    client_secret="********",
    discovery_url="string-value",
    label="string-value"
)
response = identity_providers_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: IdentityProviderRequest
  2. API Source: identity_providers_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { identityProvidersCreate } from 'waldur-js-client';

try {
  const response = await identityProvidersCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "provider": "string-value",
    "client_id": "string-value",
    "client_secret": "********",
    "discovery_url": "string-value",
    "label": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
provider string ✓
is_active boolean
client_id string ✓ ID of application used for OAuth authentication.
client_secret string ✓ Application secret key.
verify_ssl boolean
enable_post_logout_redirect boolean
enable_pkce boolean
discovery_url string ✓ The endpoint for endpoint discovery.
label string ✓ Human-readable identity provider is label.
management_url string The endpoint for user details management.
protected_fields any
extra_scope string Space-separated list of scopes to request during authentication.
user_field string The field in Waldur User model to be used for looking up the user
user_claim string The OIDC claim from the userinfo endpoint to be used as the value for the lookup field.
attribute_mapping any A JSON object mapping Waldur User model fields to OIDC claims. Example:
extra_fields string Space-separated list of extra fields to persist.
allowed_redirects any List of allowed redirect URLs for OAuth authentication. URLs must be exact matches (origin only: scheme + domain + port). HTTPS required except for localhost. No wildcards, paths, query params, or fragments. Example: ["https://portal1.example.com", "https://portal2.example.com:8443"]. If empty, falls back to HOMEPORT_URL setting.

201 -

Field Type Description
provider string
is_active boolean
client_id string ID of application used for OAuth authentication.
client_secret string Application secret key.
verify_ssl boolean
enable_post_logout_redirect boolean
enable_pkce boolean
discovery_url string The endpoint for endpoint discovery.
userinfo_url string The endpoint for fetching user info.
token_url string The endpoint for obtaining auth token.
auth_url string The endpoint for authorization request flow.
logout_url string The endpoint used to redirect after sign-out.
label string Human-readable identity provider is label.
management_url string The endpoint for user details management.
protected_fields any
extra_scope string Space-separated list of scopes to request during authentication.
user_field string The field in Waldur User model to be used for looking up the user
user_claim string The OIDC claim from the userinfo endpoint to be used as the value for the lookup field.
attribute_mapping any A JSON object mapping Waldur User model fields to OIDC claims. Example:
extra_fields string Space-separated list of extra fields to persist.
allowed_redirects any List of allowed redirect URLs for OAuth authentication. URLs must be exact matches (origin only: scheme + domain + port). HTTPS required except for localhost. No wildcards, paths, query params, or fragments. Example: ["https://portal1.example.com", "https://portal2.example.com:8443"]. If empty, falls back to HOMEPORT_URL setting.

Update

1
2
3
4
5
6
7
8
9
http \
  PUT \
  https://api.example.com/api/identity-providers/string-value/ \
  Authorization:"Token YOUR_API_TOKEN" \
  provider="string-value" \
  client_id="string-value" \
  client_secret="********" \
  discovery_url="string-value" \
  label="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.identity_provider_request import IdentityProviderRequest # (1)
from waldur_api_client.api.identity_providers import identity_providers_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = IdentityProviderRequest(
    provider="string-value",
    client_id="string-value",
    client_secret="********",
    discovery_url="string-value",
    label="string-value"
)
response = identity_providers_update.sync(
    provider="string-value",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: IdentityProviderRequest
  2. API Source: identity_providers_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
import { identityProvidersUpdate } from 'waldur-js-client';

try {
  const response = await identityProvidersUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "provider": "string-value"
  },
  body: {
    "provider": "string-value",
    "client_id": "string-value",
    "client_secret": "********",
    "discovery_url": "string-value",
    "label": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
provider string ✓
Field Type Required Description
provider string ✓
is_active boolean
client_id string ✓ ID of application used for OAuth authentication.
client_secret string ✓ Application secret key.
verify_ssl boolean
enable_post_logout_redirect boolean
enable_pkce boolean
discovery_url string ✓ The endpoint for endpoint discovery.
label string ✓ Human-readable identity provider is label.
management_url string The endpoint for user details management.
protected_fields any
extra_scope string Space-separated list of scopes to request during authentication.
user_field string The field in Waldur User model to be used for looking up the user
user_claim string The OIDC claim from the userinfo endpoint to be used as the value for the lookup field.
attribute_mapping any A JSON object mapping Waldur User model fields to OIDC claims. Example:
extra_fields string Space-separated list of extra fields to persist.
allowed_redirects any List of allowed redirect URLs for OAuth authentication. URLs must be exact matches (origin only: scheme + domain + port). HTTPS required except for localhost. No wildcards, paths, query params, or fragments. Example: ["https://portal1.example.com", "https://portal2.example.com:8443"]. If empty, falls back to HOMEPORT_URL setting.

200 -

Field Type Description
provider string
is_active boolean
client_id string ID of application used for OAuth authentication.
client_secret string Application secret key.
verify_ssl boolean
enable_post_logout_redirect boolean
enable_pkce boolean
discovery_url string The endpoint for endpoint discovery.
userinfo_url string The endpoint for fetching user info.
token_url string The endpoint for obtaining auth token.
auth_url string The endpoint for authorization request flow.
logout_url string The endpoint used to redirect after sign-out.
label string Human-readable identity provider is label.
management_url string The endpoint for user details management.
protected_fields any
extra_scope string Space-separated list of scopes to request during authentication.
user_field string The field in Waldur User model to be used for looking up the user
user_claim string The OIDC claim from the userinfo endpoint to be used as the value for the lookup field.
attribute_mapping any A JSON object mapping Waldur User model fields to OIDC claims. Example:
extra_fields string Space-separated list of extra fields to persist.
allowed_redirects any List of allowed redirect URLs for OAuth authentication. URLs must be exact matches (origin only: scheme + domain + port). HTTPS required except for localhost. No wildcards, paths, query params, or fragments. Example: ["https://portal1.example.com", "https://portal2.example.com:8443"]. If empty, falls back to HOMEPORT_URL setting.

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/identity-providers/string-value/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_identity_provider_request import PatchedIdentityProviderRequest # (1)
from waldur_api_client.api.identity_providers import identity_providers_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedIdentityProviderRequest()
response = identity_providers_partial_update.sync(
    provider="string-value",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedIdentityProviderRequest
  2. API Source: identity_providers_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { identityProvidersPartialUpdate } from 'waldur-js-client';

try {
  const response = await identityProvidersPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "provider": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
provider string ✓
Field Type Required Description
provider string
is_active boolean
client_id string ID of application used for OAuth authentication.
client_secret string Application secret key.
verify_ssl boolean
enable_post_logout_redirect boolean
enable_pkce boolean
discovery_url string The endpoint for endpoint discovery.
label string Human-readable identity provider is label.
management_url string The endpoint for user details management.
protected_fields any
extra_scope string Space-separated list of scopes to request during authentication.
user_field string The field in Waldur User model to be used for looking up the user
user_claim string The OIDC claim from the userinfo endpoint to be used as the value for the lookup field.
attribute_mapping any A JSON object mapping Waldur User model fields to OIDC claims. Example:
extra_fields string Space-separated list of extra fields to persist.
allowed_redirects any List of allowed redirect URLs for OAuth authentication. URLs must be exact matches (origin only: scheme + domain + port). HTTPS required except for localhost. No wildcards, paths, query params, or fragments. Example: ["https://portal1.example.com", "https://portal2.example.com:8443"]. If empty, falls back to HOMEPORT_URL setting.

200 -

Field Type Description
provider string
is_active boolean
client_id string ID of application used for OAuth authentication.
client_secret string Application secret key.
verify_ssl boolean
enable_post_logout_redirect boolean
enable_pkce boolean
discovery_url string The endpoint for endpoint discovery.
userinfo_url string The endpoint for fetching user info.
token_url string The endpoint for obtaining auth token.
auth_url string The endpoint for authorization request flow.
logout_url string The endpoint used to redirect after sign-out.
label string Human-readable identity provider is label.
management_url string The endpoint for user details management.
protected_fields any
extra_scope string Space-separated list of scopes to request during authentication.
user_field string The field in Waldur User model to be used for looking up the user
user_claim string The OIDC claim from the userinfo endpoint to be used as the value for the lookup field.
attribute_mapping any A JSON object mapping Waldur User model fields to OIDC claims. Example:
extra_fields string Space-separated list of extra fields to persist.
allowed_redirects any List of allowed redirect URLs for OAuth authentication. URLs must be exact matches (origin only: scheme + domain + port). HTTPS required except for localhost. No wildcards, paths, query params, or fragments. Example: ["https://portal1.example.com", "https://portal2.example.com:8443"]. If empty, falls back to HOMEPORT_URL setting.

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/identity-providers/string-value/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.identity_providers import identity_providers_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = identity_providers_destroy.sync(
    provider="string-value",
    client=client
)

print(response)
  1. API Source: identity_providers_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { identityProvidersDestroy } from 'waldur-js-client';

try {
  const response = await identityProvidersDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "provider": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
provider string ✓

204 - No response body

Other Actions

Discover OIDC provider metadata

Fetches OIDC discovery metadata from the provider and returns supported claims, scopes, and suggested mappings to Waldur User fields. Use this to configure attribute_mapping when setting up a new identity provider.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/identity-providers/discover_metadata/ \
  Authorization:"Token YOUR_API_TOKEN" \
  discovery_url="https://api.example.com/api/discovery-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.discover_metadata_request_request import DiscoverMetadataRequestRequest # (1)
from waldur_api_client.api.identity_providers import identity_providers_discover_metadata # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = DiscoverMetadataRequestRequest(
    discovery_url="https://api.example.com/api/discovery-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = identity_providers_discover_metadata.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: DiscoverMetadataRequestRequest
  2. API Source: identity_providers_discover_metadata
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { identityProvidersDiscoverMetadata } from 'waldur-js-client';

try {
  const response = await identityProvidersDiscoverMetadata({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "discovery_url": "https://api.example.com/api/discovery-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
discovery_url string (uri) ✓ OIDC discovery URL (e.g., https://idp.example.com/.well-known/openid-configuration)
verify_ssl boolean Whether to verify SSL certificate
Constraints: default: True

200 -

Field Type Description
claims_supported array of strings List of claims supported by the OIDC provider
scopes_supported array of strings List of scopes supported by the OIDC provider
endpoints object (free-form) OIDC endpoints (authorization, token, userinfo, logout)
waldur_fields array of objects Waldur User fields with suggested OIDC claim mappings
waldur_fields.field string Waldur User model field name
waldur_fields.description string Human-readable field description
waldur_fields.suggested_claims array of strings OIDC claims that could map to this field, ordered by likelihood
waldur_fields.available_claims array of strings Claims from this IdP that match the suggestions
suggested_scopes array of strings Recommended scopes to request based on claim mappings

Generate default attribute mapping

Generates a suggested attribute_mapping configuration based on the claims supported by an OIDC provider. This can be used as a starting point when creating a new identity provider.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/identity-providers/generate-mapping/ \
  Authorization:"Token YOUR_API_TOKEN" \
  discovery_url="https://api.example.com/api/discovery-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.discover_metadata_request_request import DiscoverMetadataRequestRequest # (1)
from waldur_api_client.api.identity_providers import identity_providers_generate_mapping # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = DiscoverMetadataRequestRequest(
    discovery_url="https://api.example.com/api/discovery-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = identity_providers_generate_mapping.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: DiscoverMetadataRequestRequest
  2. API Source: identity_providers_generate_mapping
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { identityProvidersGenerateMapping } from 'waldur-js-client';

try {
  const response = await identityProvidersGenerateMapping({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "discovery_url": "https://api.example.com/api/discovery-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
discovery_url string (uri) ✓ OIDC discovery URL (e.g., https://idp.example.com/.well-known/openid-configuration)
verify_ssl boolean Whether to verify SSL certificate
Constraints: default: True

200 -

Field Type Description
attribute_mapping object (free-form) Suggested mapping of Waldur fields to OIDC claims
extra_scope string Suggested scopes to request (space-separated)

Keys

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/keys/ List Keys
GET /api/keys/{uuid}/ Retrieve
POST /api/keys/ Create
DELETE /api/keys/{uuid}/ Delete
Other Actions
GET /api/keys/{uuid}/history/at/ Get object state at a specific timestamp
GET /api/keys/{uuid}/history/ Get version history

Core CRUD

List Keys

1
2
3
4
http \
  GET \
  https://api.example.com/api/keys/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.ssh_key_field_enum import SshKeyFieldEnum # (1)
from waldur_api_client.models.ssh_key_o_enum import SshKeyOEnum # (2)
from waldur_api_client.api.keys import keys_list # (3)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = keys_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: SshKeyFieldEnum
  2. Model Source: SshKeyOEnum
  3. API Source: keys_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { keysList } from 'waldur-js-client';

try {
  const response = await keysList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
created string (date-time) Created after
field array
fingerprint_md5 string
fingerprint_sha256 string
fingerprint_sha512 string
is_shared boolean
modified string (date-time) Modified after
name string Name
name_exact string Name (exact)
o array Ordering
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
user_uuid string (uuid) User UUID
uuid string (uuid) UUID

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
url string (uri)
uuid string (uuid)
name string
public_key string
fingerprint_md5 string
fingerprint_sha256 string
fingerprint_sha512 string
user_uuid string (uuid)
is_shared boolean
type string

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/keys/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.ssh_key_field_enum import SshKeyFieldEnum # (1)
from waldur_api_client.api.keys import keys_retrieve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = keys_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. Model Source: SshKeyFieldEnum
  2. API Source: keys_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { keysRetrieve } from 'waldur-js-client';

try {
  const response = await keysRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type
field array

200 -

Field Type
url string (uri)
uuid string (uuid)
name string
public_key string
fingerprint_md5 string
fingerprint_sha256 string
fingerprint_sha512 string
user_uuid string (uuid)
is_shared boolean
type string

Create

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/keys/ \
  Authorization:"Token YOUR_API_TOKEN" \
  public_key="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.ssh_key_request import SshKeyRequest # (1)
from waldur_api_client.api.keys import keys_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = SshKeyRequest(
    public_key="string-value"
)
response = keys_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: SshKeyRequest
  2. API Source: keys_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { keysCreate } from 'waldur-js-client';

try {
  const response = await keysCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "public_key": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required
name string
public_key string ✓

201 -

Field Type
url string (uri)
uuid string (uuid)
name string
public_key string
fingerprint_md5 string
fingerprint_sha256 string
fingerprint_sha512 string
user_uuid string (uuid)
is_shared boolean
type string

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/keys/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.keys import keys_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = keys_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: keys_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { keysDestroy } from 'waldur-js-client';

try {
  const response = await keysDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Other Actions

Get object state at a specific timestamp

Returns the state of the object as it was at the specified timestamp. Only accessible by staff and support users.

1
2
3
4
5
http \
  GET \
  https://api.example.com/api/keys/a1b2c3d4-e5f6-7890-abcd-ef1234567890/history/at/ \
  Authorization:"Token YOUR_API_TOKEN" \
  timestamp=="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.keys import keys_history_at_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = keys_history_at_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    timestamp="string-value"
)

print(response)
  1. API Source: keys_history_at_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { keysHistoryAtRetrieve } from 'waldur-js-client';

try {
  const response = await keysHistoryAtRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  query: {
    "timestamp": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type Required Description
timestamp string ✓ ISO 8601 timestamp to query the object state at

200 -

Field Type Description
id integer Version ID
revision_date string (date-time) When this revision was created
revision_user object (free-form) User who created this revision
revision_comment string Comment describing the revision
serialized_data object (free-form) Serialized model fields at this revision

400 -

404 -

Get version history

Returns the version history for this object. Only accessible by staff and support users.

1
2
3
4
http \
  GET \
  https://api.example.com/api/keys/a1b2c3d4-e5f6-7890-abcd-ef1234567890/history/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.ssh_key_o_enum import SshKeyOEnum # (1)
from waldur_api_client.api.keys import keys_history_list # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = keys_history_list.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

for item in response:
    print(item)
  1. Model Source: SshKeyOEnum
  2. API Source: keys_history_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { keysHistoryList } from 'waldur-js-client';

try {
  const response = await keysHistoryList({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type Description
created string (date-time) Created after
created_after string Filter versions created after this timestamp (ISO 8601)
created_before string Filter versions created before this timestamp (ISO 8601)
fingerprint_md5 string
fingerprint_sha256 string
fingerprint_sha512 string
is_shared boolean
modified string (date-time) Modified after
name string Name
name_exact string Name (exact)
o array Ordering
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
user_uuid string (uuid) User UUID
uuid string (uuid) UUID

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
id integer Version ID
revision_date string (date-time) When this revision was created
revision_user object (free-form) User who created this revision
revision_comment string Comment describing the revision
serialized_data object (free-form) Serialized model fields at this revision

Lexis Links

Method Endpoint Description
GET /api/lexis-links/ List Lexis Links
GET /api/lexis-links/{uuid}/ Retrieve
POST /api/lexis-links/ Create
PUT /api/lexis-links/{uuid}/ Update
PATCH /api/lexis-links/{uuid}/ Partial Update
DELETE /api/lexis-links/{uuid}/ Delete 
1
2
3
4
http \
  GET \
  https://api.example.com/api/lexis-links/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.lexis_links import lexis_links_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = lexis_links_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: lexis_links_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { lexisLinksList } from 'waldur-js-client';

try {
  const response = await lexisLinksList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
customer_uuid string (uuid)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
project_uuid string (uuid)
query string Filter by robot account username or type
resource_uuid string (uuid)
uuid string (uuid)

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
url string (uri)
uuid string (uuid)
created string (date-time)
modified string (date-time)
robot_account string (uri)
robot_account_username string
robot_account_type string
state string
resource_uuid string (uuid)
resource_name string
resource_type string
resource_backend_id string
resource_end_date string (date-time)
project_uuid string (uuid)
project_name string
customer_uuid string (uuid)
customer_name string
heappe_project_id integer 
1
2
3
4
http \
  GET \
  https://api.example.com/api/lexis-links/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.lexis_links import lexis_links_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = lexis_links_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: lexis_links_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { lexisLinksRetrieve } from 'waldur-js-client';

try {
  const response = await lexisLinksRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
url string (uri)
uuid string (uuid)
created string (date-time)
modified string (date-time)
robot_account string (uri)
robot_account_username string
robot_account_type string
state string
resource_uuid string (uuid)
resource_name string
resource_type string
resource_backend_id string
resource_end_date string (date-time)
project_uuid string (uuid)
project_name string
customer_uuid string (uuid)
customer_name string
heappe_project_id integer 
1
2
3
4
5
http \
  POST \
  https://api.example.com/api/lexis-links/ \
  Authorization:"Token YOUR_API_TOKEN" \
  resource="https://api.example.com/api/resource/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.lexis_link_create_request import LexisLinkCreateRequest # (1)
from waldur_api_client.api.lexis_links import lexis_links_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = LexisLinkCreateRequest(
    resource="https://api.example.com/api/resource/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = lexis_links_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: LexisLinkCreateRequest
  2. API Source: lexis_links_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { lexisLinksCreate } from 'waldur-js-client';

try {
  const response = await lexisLinksCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "resource": "https://api.example.com/api/resource/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required
resource string (uri) ✓

201 - No response body

1
2
3
4
http \
  PUT \
  https://api.example.com/api/lexis-links/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.lexis_link_request import LexisLinkRequest # (1)
from waldur_api_client.api.lexis_links import lexis_links_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = LexisLinkRequest()
response = lexis_links_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: LexisLinkRequest
  2. API Source: lexis_links_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { lexisLinksUpdate } from 'waldur-js-client';

try {
  const response = await lexisLinksUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
heappe_project_id integer

200 -

Field Type
url string (uri)
uuid string (uuid)
created string (date-time)
modified string (date-time)
robot_account string (uri)
robot_account_username string
robot_account_type string
state string
resource_uuid string (uuid)
resource_name string
resource_type string
resource_backend_id string
resource_end_date string (date-time)
project_uuid string (uuid)
project_name string
customer_uuid string (uuid)
customer_name string
heappe_project_id integer 
1
2
3
4
http \
  PATCH \
  https://api.example.com/api/lexis-links/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_lexis_link_request import PatchedLexisLinkRequest # (1)
from waldur_api_client.api.lexis_links import lexis_links_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedLexisLinkRequest()
response = lexis_links_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedLexisLinkRequest
  2. API Source: lexis_links_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { lexisLinksPartialUpdate } from 'waldur-js-client';

try {
  const response = await lexisLinksPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
heappe_project_id integer

200 -

Field Type
url string (uri)
uuid string (uuid)
created string (date-time)
modified string (date-time)
robot_account string (uri)
robot_account_username string
robot_account_type string
state string
resource_uuid string (uuid)
resource_name string
resource_type string
resource_backend_id string
resource_end_date string (date-time)
project_uuid string (uuid)
project_name string
customer_uuid string (uuid)
customer_name string
heappe_project_id integer 
1
2
3
4
http \
  DELETE \
  https://api.example.com/api/lexis-links/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.lexis_links import lexis_links_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = lexis_links_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: lexis_links_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { lexisLinksDestroy } from 'waldur-js-client';

try {
  const response = await lexisLinksDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Remote Eduteams

Operations Summary

Method Endpoint Description
POST /api/remote-eduteams/ Allows to pull user details from remote eduTEAMS instance

Allows to pull user details from remote eduTEAMS instance

Allows to pull user details from remote eduTEAMS instance.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/remote-eduteams/ \
  Authorization:"Token YOUR_API_TOKEN" \
  cuid="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.remote_eduteams_request_request import RemoteEduteamsRequestRequest # (1)
from waldur_api_client.api.remote_eduteams import remote_eduteams # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = RemoteEduteamsRequestRequest(
    cuid="string-value"
)
response = remote_eduteams.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: RemoteEduteamsRequestRequest
  2. API Source: remote_eduteams
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { remoteEduteams } from 'waldur-js-client';

try {
  const response = await remoteEduteams({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "cuid": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required
cuid string ✓

200 -

Field Type
uuid string (uuid)

Invitations and permissions

Customer Permissions Reviews

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/customer-permissions-reviews/ List Customer Permissions Reviews
GET /api/customer-permissions-reviews/{uuid}/ Retrieve
Other Actions
POST /api/customer-permissions-reviews/{uuid}/close/ Close customer permission review

Core CRUD

List Customer Permissions Reviews

1
2
3
4
http \
  GET \
  https://api.example.com/api/customer-permissions-reviews/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.customer_permission_review_o_enum import CustomerPermissionReviewOEnum # (1)
from waldur_api_client.api.customer_permissions_reviews import customer_permissions_reviews_list # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = customer_permissions_reviews_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: CustomerPermissionReviewOEnum
  2. API Source: customer_permissions_reviews_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { customerPermissionsReviewsList } from 'waldur-js-client';

try {
  const response = await customerPermissionsReviewsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
closed string (date-time)
customer_uuid string (uuid) Customer UUID
is_pending boolean Is pending
o array Ordering
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
reviewer_uuid string (uuid) Reviewer UUID

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
url string (uri)
uuid string (uuid)
reviewer_full_name string
reviewer_uuid string (uuid)
is_pending boolean
created string (date-time)
closed string (date-time)
customer_uuid string (uuid)
customer_name string

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/customer-permissions-reviews/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.customer_permissions_reviews import customer_permissions_reviews_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = customer_permissions_reviews_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: customer_permissions_reviews_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { customerPermissionsReviewsRetrieve } from 'waldur-js-client';

try {
  const response = await customerPermissionsReviewsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
url string (uri)
uuid string (uuid)
reviewer_full_name string
reviewer_uuid string (uuid)
is_pending boolean
created string (date-time)
closed string (date-time)
customer_uuid string (uuid)
customer_name string

Other Actions

Close customer permission review

1
2
3
4
http \
  POST \
  https://api.example.com/api/customer-permissions-reviews/a1b2c3d4-e5f6-7890-abcd-ef1234567890/close/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.customer_permissions_reviews import customer_permissions_reviews_close # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = customer_permissions_reviews_close.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: customer_permissions_reviews_close
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { customerPermissionsReviewsClose } from 'waldur-js-client';

try {
  const response = await customerPermissionsReviewsClose({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 - No response body

Project Permissions Reviews

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/project-permissions-reviews/ List Project Permissions Reviews
GET /api/project-permissions-reviews/{uuid}/ Retrieve
Other Actions
POST /api/project-permissions-reviews/{uuid}/close/ Close project permission review

Core CRUD

List Project Permissions Reviews

1
2
3
4
http \
  GET \
  https://api.example.com/api/project-permissions-reviews/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.customer_permission_review_o_enum import CustomerPermissionReviewOEnum # (1)
from waldur_api_client.api.project_permissions_reviews import project_permissions_reviews_list # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = project_permissions_reviews_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: CustomerPermissionReviewOEnum
  2. API Source: project_permissions_reviews_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { projectPermissionsReviewsList } from 'waldur-js-client';

try {
  const response = await projectPermissionsReviewsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
closed string (date-time)
is_pending boolean Is pending
o array Ordering
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
project_uuid string (uuid) Project UUID
reviewer_uuid string (uuid) Reviewer UUID

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
url string (uri)
uuid string (uuid)
reviewer_full_name string
reviewer_uuid string (uuid)
is_pending boolean
created string (date-time)
closed string (date-time)
project_uuid string (uuid)
project_name string

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/project-permissions-reviews/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.project_permissions_reviews import project_permissions_reviews_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = project_permissions_reviews_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: project_permissions_reviews_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { projectPermissionsReviewsRetrieve } from 'waldur-js-client';

try {
  const response = await projectPermissionsReviewsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
url string (uri)
uuid string (uuid)
reviewer_full_name string
reviewer_uuid string (uuid)
is_pending boolean
created string (date-time)
closed string (date-time)
project_uuid string (uuid)
project_name string

Other Actions

Close project permission review

Complete project permission review.

1
2
3
4
http \
  POST \
  https://api.example.com/api/project-permissions-reviews/a1b2c3d4-e5f6-7890-abcd-ef1234567890/close/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.project_permissions_reviews import project_permissions_reviews_close # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = project_permissions_reviews_close.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: project_permissions_reviews_close
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { projectPermissionsReviewsClose } from 'waldur-js-client';

try {
  const response = await projectPermissionsReviewsClose({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 - No response body

User Group Invitations

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/user-group-invitations/ List group invitations
GET /api/user-group-invitations/{uuid}/ Retrieve group invitation
POST /api/user-group-invitations/ Create group invitation
PUT /api/user-group-invitations/{uuid}/ Update a group invitation
PATCH /api/user-group-invitations/{uuid}/ Partially update a group invitation
DELETE /api/user-group-invitations/{uuid}/ Delete a group invitation
Other Actions
GET /api/user-group-invitations/{uuid}/projects/ List projects for a customer-scoped group invitation
POST /api/user-group-invitations/{uuid}/cancel/ Cancel a group invitation
POST /api/user-group-invitations/{uuid}/submit_request/ Submit a permission request

Core CRUD

List group invitations

Retrieve a list of group invitations. Unauthenticated users can only see public invitations.

1
2
3
4
http \
  GET \
  https://api.example.com/api/user-group-invitations/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.backend_resource_req_o_enum import BackendResourceReqOEnum # (1)
from waldur_api_client.api.user_group_invitations import user_group_invitations_list # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = user_group_invitations_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: BackendResourceReqOEnum
  2. API Source: user_group_invitations_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { userGroupInvitationsList } from 'waldur-js-client';

try {
  const response = await userGroupInvitationsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
customer_uuid string (uuid)
is_active boolean
is_public boolean
o array Ordering
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
role_name string
role_uuid string (uuid)
scope string (uri) Filter by scope URL.
scope_type string

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
scope_uuid string (uuid) UUID of the invitation scope (Customer or Project)
scope_name string Name of the invitation scope
scope_description string Description of the invitation scope
scope_type string Type of the invitation scope (e.g., 'customer', 'project')
customer_uuid string (uuid) UUID of the customer organization
customer_name string Name of the customer organization
role_name string Name of the role being granted (e.g., 'PROJECT.ADMIN')
role_description string Description of the role being granted
created_by_full_name string Full name of the user who created this invitation
created_by_username string Username of the user who created this invitation
created_by_image string (uri) Profile image of the user who created this invitation
url string (uri)
uuid string (uuid)
role string (uuid) UUID of the role to grant to the invited user
created string (date-time)
is_active boolean
is_public boolean Allow non-authenticated users to see and accept this invitation. Only staff can create public invitations.
auto_create_project boolean Create project and grant project permissions instead of customer permissions
auto_approve boolean Automatically approve permission requests from users matching email patterns or affiliations
project_name_template string Template for project name. Supports {username}, {email}, {full_name} variables
project_role string (uuid) UUID of the project role to grant if auto_create_project is enabled
user_affiliations any
user_email_patterns any
user_identity_sources any List of allowed identity sources (identity providers).
scope_image string (uri) Image URL of the invitation scope (Customer or Project)
custom_text string Custom description text displayed to users viewing this invitation.

Retrieve group invitation

Retrieve details of a specific group invitation. Unauthenticated users can only see public invitations.

1
2
3
4
http \
  GET \
  https://api.example.com/api/user-group-invitations/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.user_group_invitations import user_group_invitations_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = user_group_invitations_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: user_group_invitations_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { userGroupInvitationsRetrieve } from 'waldur-js-client';

try {
  const response = await userGroupInvitationsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
scope_uuid string (uuid) UUID of the invitation scope (Customer or Project)
scope_name string Name of the invitation scope
scope_description string Description of the invitation scope
scope_type string Type of the invitation scope (e.g., 'customer', 'project')
customer_uuid string (uuid) UUID of the customer organization
customer_name string Name of the customer organization
role_name string Name of the role being granted (e.g., 'PROJECT.ADMIN')
role_description string Description of the role being granted
created_by_full_name string Full name of the user who created this invitation
created_by_username string Username of the user who created this invitation
created_by_image string (uri) Profile image of the user who created this invitation
url string (uri)
uuid string (uuid)
role string (uuid) UUID of the role to grant to the invited user
created string (date-time)
is_active boolean
is_public boolean Allow non-authenticated users to see and accept this invitation. Only staff can create public invitations.
auto_create_project boolean Create project and grant project permissions instead of customer permissions
auto_approve boolean Automatically approve permission requests from users matching email patterns or affiliations
project_name_template string Template for project name. Supports {username}, {email}, {full_name} variables
project_role string (uuid) UUID of the project role to grant if auto_create_project is enabled
user_affiliations any
user_email_patterns any
user_identity_sources any List of allowed identity sources (identity providers).
scope_image string (uri) Image URL of the invitation scope (Customer or Project)
custom_text string Custom description text displayed to users viewing this invitation.

Create group invitation

Create a new group invitation, which acts as a template for users to request permissions.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/user-group-invitations/ \
  Authorization:"Token YOUR_API_TOKEN" \
  role="a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  scope="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.group_invitation_request import GroupInvitationRequest # (1)
from waldur_api_client.api.user_group_invitations import user_group_invitations_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = GroupInvitationRequest(
    role="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    scope="string-value"
)
response = user_group_invitations_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: GroupInvitationRequest
  2. API Source: user_group_invitations_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { userGroupInvitationsCreate } from 'waldur-js-client';

try {
  const response = await userGroupInvitationsCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "role": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "scope": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
role string (uuid) ✓ UUID of the role to grant to the invited user
scope string ✓ URL of the scope (Customer or Project) for this invitation
Constraints: write-only
is_public boolean Allow non-authenticated users to see and accept this invitation. Only staff can create public invitations.
auto_create_project boolean Create project and grant project permissions instead of customer permissions
auto_approve boolean Automatically approve permission requests from users matching email patterns or affiliations
project_name_template string Template for project name. Supports {username}, {email}, {full_name} variables
project_role string (uuid) UUID of the project role to grant if auto_create_project is enabled
user_affiliations any
user_email_patterns any
user_identity_sources any List of allowed identity sources (identity providers).
custom_text string Custom description text displayed to users viewing this invitation.

201 -

Field Type Description
scope_uuid string (uuid) UUID of the invitation scope (Customer or Project)
scope_name string Name of the invitation scope
scope_description string Description of the invitation scope
scope_type string Type of the invitation scope (e.g., 'customer', 'project')
customer_uuid string (uuid) UUID of the customer organization
customer_name string Name of the customer organization
role_name string Name of the role being granted (e.g., 'PROJECT.ADMIN')
role_description string Description of the role being granted
created_by_full_name string Full name of the user who created this invitation
created_by_username string Username of the user who created this invitation
created_by_image string (uri) Profile image of the user who created this invitation
url string (uri)
uuid string (uuid)
role string (uuid) UUID of the role to grant to the invited user
created string (date-time)
is_active boolean
is_public boolean Allow non-authenticated users to see and accept this invitation. Only staff can create public invitations.
auto_create_project boolean Create project and grant project permissions instead of customer permissions
auto_approve boolean Automatically approve permission requests from users matching email patterns or affiliations
project_name_template string Template for project name. Supports {username}, {email}, {full_name} variables
project_role string (uuid) UUID of the project role to grant if auto_create_project is enabled
user_affiliations any
user_email_patterns any
user_identity_sources any List of allowed identity sources (identity providers).
scope_image string (uri) Image URL of the invitation scope (Customer or Project)
custom_text string Custom description text displayed to users viewing this invitation.

Update a group invitation

Update an active group invitation. Only active invitations can be edited.

1
2
3
4
http \
  PUT \
  https://api.example.com/api/user-group-invitations/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.group_invitation_update_request import GroupInvitationUpdateRequest # (1)
from waldur_api_client.api.user_group_invitations import user_group_invitations_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = GroupInvitationUpdateRequest()
response = user_group_invitations_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: GroupInvitationUpdateRequest
  2. API Source: user_group_invitations_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { userGroupInvitationsUpdate } from 'waldur-js-client';

try {
  const response = await userGroupInvitationsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
is_public boolean Allow non-authenticated users to see and accept this invitation. Only staff can create public invitations.
role string (uuid) UUID of the role to grant.
scope string URL of the scope (Customer or Project) for this invitation
auto_create_project boolean Create project and grant project permissions instead of customer permissions
auto_approve boolean Automatically approve permission requests from users matching email patterns or affiliations
project_name_template string Template for project name. Supports {username}, {email}, {full_name} variables
project_role string (uuid) UUID of the project role to grant if auto_create_project is enabled
user_affiliations any
user_email_patterns any
user_identity_sources any List of allowed identity sources (identity providers).
custom_text string Custom description text displayed to users viewing this invitation.

200 -

Field Type Description
is_public boolean Allow non-authenticated users to see and accept this invitation. Only staff can create public invitations.
role string (uuid) UUID of the role to grant.
scope string URL of the scope (Customer or Project) for this invitation
auto_create_project boolean Create project and grant project permissions instead of customer permissions
auto_approve boolean Automatically approve permission requests from users matching email patterns or affiliations
project_name_template string Template for project name. Supports {username}, {email}, {full_name} variables
project_role string (uuid) UUID of the project role to grant if auto_create_project is enabled
user_affiliations any
user_email_patterns any
user_identity_sources any List of allowed identity sources (identity providers).
custom_text string Custom description text displayed to users viewing this invitation.

Partially update a group invitation

Partially update an active group invitation. Only active invitations can be edited.

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/user-group-invitations/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_group_invitation_update_request import PatchedGroupInvitationUpdateRequest # (1)
from waldur_api_client.api.user_group_invitations import user_group_invitations_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedGroupInvitationUpdateRequest()
response = user_group_invitations_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedGroupInvitationUpdateRequest
  2. API Source: user_group_invitations_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { userGroupInvitationsPartialUpdate } from 'waldur-js-client';

try {
  const response = await userGroupInvitationsPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
is_public boolean Allow non-authenticated users to see and accept this invitation. Only staff can create public invitations.
role string (uuid) UUID of the role to grant.
scope string URL of the scope (Customer or Project) for this invitation
auto_create_project boolean Create project and grant project permissions instead of customer permissions
auto_approve boolean Automatically approve permission requests from users matching email patterns or affiliations
project_name_template string Template for project name. Supports {username}, {email}, {full_name} variables
project_role string (uuid) UUID of the project role to grant if auto_create_project is enabled
user_affiliations any
user_email_patterns any
user_identity_sources any List of allowed identity sources (identity providers).
custom_text string Custom description text displayed to users viewing this invitation.

200 -

Field Type Description
is_public boolean Allow non-authenticated users to see and accept this invitation. Only staff can create public invitations.
role string (uuid) UUID of the role to grant.
scope string URL of the scope (Customer or Project) for this invitation
auto_create_project boolean Create project and grant project permissions instead of customer permissions
auto_approve boolean Automatically approve permission requests from users matching email patterns or affiliations
project_name_template string Template for project name. Supports {username}, {email}, {full_name} variables
project_role string (uuid) UUID of the project role to grant if auto_create_project is enabled
user_affiliations any
user_email_patterns any
user_identity_sources any List of allowed identity sources (identity providers).
custom_text string Custom description text displayed to users viewing this invitation.

Delete a group invitation

Deletes an inactive group invitation. Only invitations that have been canceled (is_active=False) can be deleted.

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/user-group-invitations/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.user_group_invitations import user_group_invitations_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = user_group_invitations_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: user_group_invitations_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { userGroupInvitationsDestroy } from 'waldur-js-client';

try {
  const response = await userGroupInvitationsDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Other Actions

List projects for a customer-scoped group invitation

For a group invitation scoped to a customer, this endpoint lists all projects within that customer.

1
2
3
4
http \
  GET \
  https://api.example.com/api/user-group-invitations/a1b2c3d4-e5f6-7890-abcd-ef1234567890/projects/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.user_group_invitations import user_group_invitations_projects_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = user_group_invitations_projects_list.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

for item in response:
    print(item)
  1. API Source: user_group_invitations_projects_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { userGroupInvitationsProjectsList } from 'waldur-js-client';

try {
  const response = await userGroupInvitationsProjectsList({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
uuid string (uuid)
url string (uri)

Cancel a group invitation

Cancels an active group invitation, preventing new permission requests from being created.

1
2
3
4
http \
  POST \
  https://api.example.com/api/user-group-invitations/a1b2c3d4-e5f6-7890-abcd-ef1234567890/cancel/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.user_group_invitations import user_group_invitations_cancel # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = user_group_invitations_cancel.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: user_group_invitations_cancel
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { userGroupInvitationsCancel } from 'waldur-js-client';

try {
  const response = await userGroupInvitationsCancel({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 - No response body

Submit a permission request

Creates a permission request based on a group invitation for the currently authenticated user. If the invitation has auto_approve enabled and the user matches the required patterns, the request is automatically approved.

1
2
3
4
http \
  POST \
  https://api.example.com/api/user-group-invitations/a1b2c3d4-e5f6-7890-abcd-ef1234567890/submit_request/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.user_group_invitations import user_group_invitations_submit_request # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = user_group_invitations_submit_request.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: user_group_invitations_submit_request
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { userGroupInvitationsSubmitRequest } from 'waldur-js-client';

try {
  const response = await userGroupInvitationsSubmitRequest({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
uuid string UUID of the created permission request
scope_name string Name of the invitation scope
scope_uuid string UUID of the invitation scope
auto_approved boolean Whether the request was automatically approved

User Invitations

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/user-invitations/ List user invitations
GET /api/user-invitations/{uuid}/ Retrieve user invitation
POST /api/user-invitations/ Create user invitation
PUT /api/user-invitations/{uuid}/ Update user invitation
PATCH /api/user-invitations/{uuid}/ Partially update user invitation
DELETE /api/user-invitations/{uuid}/ Delete user invitation
Other Actions
GET /api/user-invitations/{uuid}/details/ Get public invitation details
POST /api/user-invitations/{uuid}/accept/ Accept an invitation
POST /api/user-invitations/approve/ Approve a requested invitation
POST /api/user-invitations/{uuid}/cancel/ Cancel an invitation
POST /api/user-invitations/{uuid}/check/ Check invitation validity
POST /api/user-invitations/check-duplicates/ Check for duplicate invitations
POST /api/user-invitations/{uuid}/delete/ Delete an invitation (staff only)
POST /api/user-invitations/reject/ Reject a requested invitation
POST /api/user-invitations/{uuid}/send/ Resend an invitation

Core CRUD

List user invitations

Retrieve a list of user invitations visible to the current user.

1
2
3
4
http \
  GET \
  https://api.example.com/api/user-invitations/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.invitation_o_enum import InvitationOEnum # (1)
from waldur_api_client.models.invitation_state import InvitationState # (2)
from waldur_api_client.api.user_invitations import user_invitations_list # (3)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = user_invitations_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: InvitationOEnum
  2. Model Source: InvitationState
  3. API Source: user_invitations_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { userInvitationsList } from 'waldur-js-client';

try {
  const response = await userInvitationsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
civil_number string
customer_uuid string (uuid)
email string
email_exact string
o array Ordering
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
role_name string
role_uuid string (uuid)
scope string (uri) Filter by scope URL.
scope_description string
scope_name string
scope_type string
state array

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
scope_uuid string (uuid) UUID of the invitation scope (Customer or Project)
scope_name string Name of the invitation scope
scope_description string Description of the invitation scope
scope_type string Type of the invitation scope (e.g., 'customer', 'project')
customer_uuid string (uuid) UUID of the customer organization
customer_name string Name of the customer organization
role_name string Name of the role being granted (e.g., 'PROJECT.ADMIN')
role_description string Description of the role being granted
created_by_full_name string Full name of the user who created this invitation
created_by_username string Username of the user who created this invitation
created_by_image string (uri) Profile image of the user who created this invitation
url string (uri)
uuid string (uuid)
role string (uuid) UUID of the role to grant to the invited user
created string (date-time)
expires string (date-time) Expiration date and time of the invitation
full_name string
native_name string
phone_number string
organization string
job_title string
email string (email) Invitation link will be sent to this email. Note that user can accept invitation with different email.
civil_number string Civil number of invited user. If civil number is not defined any user can accept invitation.
state any
error_message string
extra_invitation_text string
execution_state any

Retrieve user invitation

Retrieve details of a specific user invitation.

1
2
3
4
http \
  GET \
  https://api.example.com/api/user-invitations/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.user_invitations import user_invitations_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = user_invitations_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: user_invitations_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { userInvitationsRetrieve } from 'waldur-js-client';

try {
  const response = await userInvitationsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
scope_uuid string (uuid) UUID of the invitation scope (Customer or Project)
scope_name string Name of the invitation scope
scope_description string Description of the invitation scope
scope_type string Type of the invitation scope (e.g., 'customer', 'project')
customer_uuid string (uuid) UUID of the customer organization
customer_name string Name of the customer organization
role_name string Name of the role being granted (e.g., 'PROJECT.ADMIN')
role_description string Description of the role being granted
created_by_full_name string Full name of the user who created this invitation
created_by_username string Username of the user who created this invitation
created_by_image string (uri) Profile image of the user who created this invitation
url string (uri)
uuid string (uuid)
role string (uuid) UUID of the role to grant to the invited user
created string (date-time)
expires string (date-time) Expiration date and time of the invitation
full_name string
native_name string
phone_number string
organization string
job_title string
email string (email) Invitation link will be sent to this email. Note that user can accept invitation with different email.
civil_number string Civil number of invited user. If civil number is not defined any user can accept invitation.
state any
error_message string
extra_invitation_text string
execution_state any

Create user invitation

Create a new user invitation to grant a role in a specific scope (e.g., organization or project).

1
2
3
4
5
6
7
http \
  POST \
  https://api.example.com/api/user-invitations/ \
  Authorization:"Token YOUR_API_TOKEN" \
  role="a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  scope="string-value" \
  email="alice@example.com"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.invitation_request import InvitationRequest # (1)
from waldur_api_client.api.user_invitations import user_invitations_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = InvitationRequest(
    role="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    scope="string-value",
    email="alice@example.com"
)
response = user_invitations_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: InvitationRequest
  2. API Source: user_invitations_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
import { userInvitationsCreate } from 'waldur-js-client';

try {
  const response = await userInvitationsCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "role": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "scope": "string-value",
    "email": "alice@example.com"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
role string (uuid) ✓ UUID of the role to grant to the invited user
scope string ✓ URL of the scope (Customer or Project) for this invitation
Constraints: write-only
full_name string
native_name string
phone_number string
organization string
job_title string
email string (email) ✓ Invitation link will be sent to this email. Note that user can accept invitation with different email.
civil_number string Civil number of invited user. If civil number is not defined any user can accept invitation.
extra_invitation_text string

201 -

Field Type Description
scope_uuid string (uuid) UUID of the invitation scope (Customer or Project)
scope_name string Name of the invitation scope
scope_description string Description of the invitation scope
scope_type string Type of the invitation scope (e.g., 'customer', 'project')
customer_uuid string (uuid) UUID of the customer organization
customer_name string Name of the customer organization
role_name string Name of the role being granted (e.g., 'PROJECT.ADMIN')
role_description string Description of the role being granted
created_by_full_name string Full name of the user who created this invitation
created_by_username string Username of the user who created this invitation
created_by_image string (uri) Profile image of the user who created this invitation
url string (uri)
uuid string (uuid)
role string (uuid) UUID of the role to grant to the invited user
created string (date-time)
expires string (date-time) Expiration date and time of the invitation
full_name string
native_name string
phone_number string
organization string
job_title string
email string (email) Invitation link will be sent to this email. Note that user can accept invitation with different email.
civil_number string Civil number of invited user. If civil number is not defined any user can accept invitation.
state any
error_message string
extra_invitation_text string
execution_state any

Update user invitation

Update an existing user invitation. Only pending invitations can be edited. Allows changing email and role within the same scope.

1
2
3
4
5
http \
  PUT \
  https://api.example.com/api/user-invitations/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  email="alice@example.com"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.invitation_update_request import InvitationUpdateRequest # (1)
from waldur_api_client.api.user_invitations import user_invitations_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = InvitationUpdateRequest(
    email="alice@example.com"
)
response = user_invitations_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: InvitationUpdateRequest
  2. API Source: user_invitations_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { userInvitationsUpdate } from 'waldur-js-client';

try {
  const response = await userInvitationsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "email": "alice@example.com"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
email string (email) ✓ Invitation link will be sent to this email. Note that user can accept invitation with different email.
role string (uuid) UUID of the new role to assign. Must be compatible with the invitation scope.

200 -

Field Type Description
email string (email) Invitation link will be sent to this email. Note that user can accept invitation with different email.
role string (uuid) UUID of the new role to assign. Must be compatible with the invitation scope.

Partially update user invitation

Partially update an existing user invitation. Only pending invitations can be edited. Allows changing email and role within the same scope.

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/user-invitations/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_invitation_update_request import PatchedInvitationUpdateRequest # (1)
from waldur_api_client.api.user_invitations import user_invitations_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedInvitationUpdateRequest()
response = user_invitations_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedInvitationUpdateRequest
  2. API Source: user_invitations_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { userInvitationsPartialUpdate } from 'waldur-js-client';

try {
  const response = await userInvitationsPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
email string (email) Invitation link will be sent to this email. Note that user can accept invitation with different email.
role string (uuid) UUID of the new role to assign. Must be compatible with the invitation scope.

200 -

Field Type Description
email string (email) Invitation link will be sent to this email. Note that user can accept invitation with different email.
role string (uuid) UUID of the new role to assign. Must be compatible with the invitation scope.

Delete user invitation

Delete a user invitation. Only users with invitation management permissions can delete invitations.

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/user-invitations/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.user_invitations import user_invitations_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = user_invitations_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: user_invitations_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { userInvitationsDestroy } from 'waldur-js-client';

try {
  const response = await userInvitationsDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Other Actions

Get public invitation details

Retrieves public-facing details of an invitation. This is used to show information to a user before they accept it.

1
2
3
4
http \
  GET \
  https://api.example.com/api/user-invitations/a1b2c3d4-e5f6-7890-abcd-ef1234567890/details/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.user_invitations import user_invitations_details_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = user_invitations_details_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: user_invitations_details_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { userInvitationsDetailsRetrieve } from 'waldur-js-client';

try {
  const response = await userInvitationsDetailsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
scope_uuid string (uuid) UUID of the invitation scope (Customer or Project)
scope_name string Name of the invitation scope
scope_description string Description of the invitation scope
scope_type string Type of the invitation scope (e.g., 'customer', 'project')
customer_uuid string (uuid) UUID of the customer organization
customer_name string Name of the customer organization
role_name string Name of the role being granted (e.g., 'PROJECT.ADMIN')
role_description string Description of the role being granted
created_by_full_name string Full name of the user who created this invitation
created_by_username string Username of the user who created this invitation
created_by_image string (uri) Profile image of the user who created this invitation
email string (email) Invitation link will be sent to this email. Note that user can accept invitation with different email.
error_message string
execution_state any
state any Current state of the invitation (e.g., 'pending', 'accepted', 'rejected')

Accept an invitation

Accepts an invitation for the currently authenticated user. This grants the user the specified role in the invitation's scope.

1
2
3
4
http \
  POST \
  https://api.example.com/api/user-invitations/a1b2c3d4-e5f6-7890-abcd-ef1234567890/accept/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.user_invitations import user_invitations_accept # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = user_invitations_accept.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: user_invitations_accept
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { userInvitationsAccept } from 'waldur-js-client';

try {
  const response = await userInvitationsAccept({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 - No response body

Approve a requested invitation

1
2
    For user's convenience invitation approval is performed without authentication.
    User UUID and invitation UUID is encoded into cryptographically signed token.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/user-invitations/approve/ \
  Authorization:"Token YOUR_API_TOKEN" \
  token="********"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.token_request import TokenRequest # (1)
from waldur_api_client.api.user_invitations import user_invitations_approve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = TokenRequest(
    token="********"
)
response = user_invitations_approve.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: TokenRequest
  2. API Source: user_invitations_approve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { userInvitationsApprove } from 'waldur-js-client';

try {
  const response = await userInvitationsApprove({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "token": "********"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
token string ✓ Authentication token for invitation acceptance

200 - No response body

Cancel an invitation

Cancels a pending or planned (pending_project) invitation.

1
2
3
4
http \
  POST \
  https://api.example.com/api/user-invitations/a1b2c3d4-e5f6-7890-abcd-ef1234567890/cancel/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.user_invitations import user_invitations_cancel # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = user_invitations_cancel.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: user_invitations_cancel
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { userInvitationsCancel } from 'waldur-js-client';

try {
  const response = await userInvitationsCancel({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Check invitation validity

Checks if an invitation is pending and returns its email and whether a civil number is required for acceptance. This endpoint is public and does not require authentication.

1
2
3
4
http \
  POST \
  https://api.example.com/api/user-invitations/a1b2c3d4-e5f6-7890-abcd-ef1234567890/check/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.user_invitations import user_invitations_check # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = user_invitations_check.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: user_invitations_check
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { userInvitationsCheck } from 'waldur-js-client';

try {
  const response = await userInvitationsCheck({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
email string (email) Email address to check for existing invitations
civil_number_required boolean Whether civil number verification is required

Check for duplicate invitations

Returns pending invitations that already exist for the same email and role within the given scope.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/user-invitations/check-duplicates/ \
  Authorization:"Token YOUR_API_TOKEN" \
  scope="string-value" \
  invitations:='[]'

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.invitation_duplicate_check_request import InvitationDuplicateCheckRequest # (1)
from waldur_api_client.api.user_invitations import user_invitations_check_duplicates # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = InvitationDuplicateCheckRequest(
    scope="string-value",
    invitations=[]
)
response = user_invitations_check_duplicates.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: InvitationDuplicateCheckRequest
  2. API Source: user_invitations_check_duplicates
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { userInvitationsCheckDuplicates } from 'waldur-js-client';

try {
  const response = await userInvitationsCheckDuplicates({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "scope": "string-value",
    "invitations": []
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
scope string ✓ URL of the scope (Customer or Project) for this invitation list
invitations array of objects ✓
invitations.email string (email) ✓
invitations.role string (uuid) ✓ UUID of the role to grant to the invited user

200 -

Field Type
duplicates array of objects
duplicates.email string (email)
duplicates.role string (uuid)
duplicates.existing_invitation_uuid string (uuid)

Delete an invitation (staff only)

Deletes an invitation. This action is restricted to staff users.

1
2
3
4
http \
  POST \
  https://api.example.com/api/user-invitations/a1b2c3d4-e5f6-7890-abcd-ef1234567890/delete/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.user_invitations import user_invitations_delete # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = user_invitations_delete.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: user_invitations_delete
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { userInvitationsDelete } from 'waldur-js-client';

try {
  const response = await userInvitationsDelete({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 - No response body

Reject a requested invitation

1
2
    For user's convenience invitation reject action is performed without authentication.
    User UUID and invitation UUID is encoded into cryptographically signed token.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/user-invitations/reject/ \
  Authorization:"Token YOUR_API_TOKEN" \
  token="********"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.token_request import TokenRequest # (1)
from waldur_api_client.api.user_invitations import user_invitations_reject # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = TokenRequest(
    token="********"
)
response = user_invitations_reject.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: TokenRequest
  2. API Source: user_invitations_reject
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { userInvitationsReject } from 'waldur-js-client';

try {
  const response = await userInvitationsReject({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "token": "********"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
token string ✓ Authentication token for invitation acceptance

200 - No response body

Resend an invitation

Resends an email for a pending, expired, or canceled invitation. If the invitation was expired or canceled, its state is reset to 'pending' and its creation time is updated.

1
2
3
4
http \
  POST \
  https://api.example.com/api/user-invitations/a1b2c3d4-e5f6-7890-abcd-ef1234567890/send/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.user_invitations import user_invitations_send # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = user_invitations_send.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: user_invitations_send
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { userInvitationsSend } from 'waldur-js-client';

try {
  const response = await userInvitationsSend({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 - No response body

User Permission Requests

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/user-permission-requests/ List permission requests
GET /api/user-permission-requests/{uuid}/ Retrieve permission request
Other Actions
POST /api/user-permission-requests/{uuid}/approve/ Approve a permission request
POST /api/user-permission-requests/{uuid}/cancel_request/ Cancel a permission request
POST /api/user-permission-requests/{uuid}/reject/ Reject a permission request

Core CRUD

List permission requests

Retrieve a list of permission requests visible to the user.

1
2
3
4
http \
  GET \
  https://api.example.com/api/user-permission-requests/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.proposal_review_o_enum import ProposalReviewOEnum # (1)
from waldur_api_client.models.remote_project_update_request_state_enum import RemoteProjectUpdateRequestStateEnum # (2)
from waldur_api_client.api.user_permission_requests import user_permission_requests_list # (3)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = user_permission_requests_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: ProposalReviewOEnum
  2. Model Source: RemoteProjectUpdateRequestStateEnum
  3. API Source: user_permission_requests_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { userPermissionRequestsList } from 'waldur-js-client';

try {
  const response = await userPermissionRequestsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
created_by string (uuid)
customer_uuid string (uuid)
invitation string (uuid)
o array Ordering
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
scope string (uri) Filter by scope URL.
state array

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
invitation string (uri)
state string
created string (date-time)
created_by_full_name string
created_by_username string
created_by_email string (email)
reviewed_by_full_name string
reviewed_by_username string
reviewed_at string (date-time) Timestamp when the review was completed
review_comment string Optional comment provided during review
scope_uuid string (uuid)
scope_name string
customer_uuid string (uuid)
customer_name string
role_name string
role_description string
project_name_template string

Retrieve permission request

Retrieve details of a specific permission request.

1
2
3
4
http \
  GET \
  https://api.example.com/api/user-permission-requests/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.user_permission_requests import user_permission_requests_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = user_permission_requests_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: user_permission_requests_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { userPermissionRequestsRetrieve } from 'waldur-js-client';

try {
  const response = await userPermissionRequestsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
url string (uri)
uuid string (uuid)
invitation string (uri)
state string
created string (date-time)
created_by_full_name string
created_by_username string
created_by_email string (email)
reviewed_by_full_name string
reviewed_by_username string
reviewed_at string (date-time) Timestamp when the review was completed
review_comment string Optional comment provided during review
scope_uuid string (uuid)
scope_name string
customer_uuid string (uuid)
customer_name string
role_name string
role_description string
project_name_template string

Other Actions

Approve a permission request

Approves a pending permission request, granting the requesting user the permissions defined in the associated group invitation.

1
2
3
4
http \
  POST \
  https://api.example.com/api/user-permission-requests/a1b2c3d4-e5f6-7890-abcd-ef1234567890/approve/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.review_comment_request import ReviewCommentRequest # (1)
from waldur_api_client.api.user_permission_requests import user_permission_requests_approve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ReviewCommentRequest()
response = user_permission_requests_approve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ReviewCommentRequest
  2. API Source: user_permission_requests_approve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { userPermissionRequestsApprove } from 'waldur-js-client';

try {
  const response = await userPermissionRequestsApprove({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
comment string Optional comment for review

200 - No response body

Cancel a permission request

Cancels a pending or draft permission request. This can be done by the user who created the request or by a staff member.

1
2
3
4
http \
  POST \
  https://api.example.com/api/user-permission-requests/a1b2c3d4-e5f6-7890-abcd-ef1234567890/cancel_request/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.user_permission_requests import user_permission_requests_cancel_request # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = user_permission_requests_cancel_request.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: user_permission_requests_cancel_request
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { userPermissionRequestsCancelRequest } from 'waldur-js-client';

try {
  const response = await userPermissionRequestsCancelRequest({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
uuid string UUID of the canceled permission request
scope_name string Name of the invitation scope
scope_uuid string UUID of the invitation scope

Reject a permission request

Rejects a pending permission request.

1
2
3
4
http \
  POST \
  https://api.example.com/api/user-permission-requests/a1b2c3d4-e5f6-7890-abcd-ef1234567890/reject/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.review_comment_request import ReviewCommentRequest # (1)
from waldur_api_client.api.user_permission_requests import user_permission_requests_reject # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ReviewCommentRequest()
response = user_permission_requests_reject.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ReviewCommentRequest
  2. API Source: user_permission_requests_reject
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { userPermissionRequestsReject } from 'waldur-js-client';

try {
  const response = await userPermissionRequestsReject({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
comment string Optional comment for review

200 - No response body

User Permissions

Operations Summary

Method Endpoint Description
GET /api/user-permissions/ List user permissions
GET /api/user-permissions/{uuid}/ Get permission details

List user permissions

Get a list of all permissions for the current user. Staff and support users can view all user permissions. The list can be filtered by user, scope, role, etc.

1
2
3
4
http \
  GET \
  https://api.example.com/api/user-permissions/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.offering_permission_o_enum import OfferingPermissionOEnum # (1)
from waldur_api_client.api.user_permissions import user_permissions_list # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = user_permissions_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: OfferingPermissionOEnum
  2. API Source: user_permissions_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { userPermissionsList } from 'waldur-js-client';

try {
  const response = await userPermissionsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
created string (date-time) Created after
expiration_time string (date-time)
full_name string User full name contains
modified string (date-time) Modified after
native_name string
o array Ordering
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
role_name string Role name contains
role_uuid string (uuid) Role UUID
scope_name string Scope name
scope_type string Scope type
scope_uuid string Scope UUID
user string (uuid)
user_slug string User slug contains
user_url string (uri)
username string

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
user_uuid string (uuid)
user_name string
user_slug string
created string (date-time)
expiration_time string (date-time)
created_by_full_name string
created_by_username string
role_name string
role_description string
role_uuid string (uuid)
scope_type string
scope_uuid string (uuid)
scope_name string
customer_uuid string (uuid)
customer_name string

Get permission details

Retrieve the details of a specific user permission grant by its UUID.

1
2
3
4
http \
  GET \
  https://api.example.com/api/user-permissions/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.user_permissions import user_permissions_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = user_permissions_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: user_permissions_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { userPermissionsRetrieve } from 'waldur-js-client';

try {
  const response = await userPermissionsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
user_uuid string (uuid)
user_name string
user_slug string
created string (date-time)
expiration_time string (date-time)
created_by_full_name string
created_by_username string
role_name string
role_description string
role_uuid string (uuid)
scope_type string
scope_uuid string (uuid)
scope_name string
customer_uuid string (uuid)
customer_name string

Notifications and logging

Admin Announcements

Operations Summary

Method Endpoint Description
GET /api/admin-announcements/ List Admin Announcements
GET /api/admin-announcements/{uuid}/ Retrieve
POST /api/admin-announcements/ Create
PUT /api/admin-announcements/{uuid}/ Update
PATCH /api/admin-announcements/{uuid}/ Partial Update
DELETE /api/admin-announcements/{uuid}/ Delete

List Admin Announcements

1
2
3
4
http \
  GET \
  https://api.example.com/api/admin-announcements/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.admin_announcement_field_enum import AdminAnnouncementFieldEnum # (1)
from waldur_api_client.models.admin_announcement_o_enum import AdminAnnouncementOEnum # (2)
from waldur_api_client.models.admin_announcement_type_enum import AdminAnnouncementTypeEnum # (3)
from waldur_api_client.api.admin_announcements import admin_announcements_list # (4)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = admin_announcements_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: AdminAnnouncementFieldEnum
  2. Model Source: AdminAnnouncementOEnum
  3. Model Source: AdminAnnouncementTypeEnum
  4. API Source: admin_announcements_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { adminAnnouncementsList } from 'waldur-js-client';

try {
  const response = await adminAnnouncementsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
description string
field array
is_active boolean
o array Ordering
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
type array

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
uuid string (uuid)
description string
active_from string (date-time)
active_to string (date-time)
is_active boolean
type string
created string (date-time)
maintenance_uuid string
maintenance_name string
maintenance_type string
maintenance_state string
maintenance_scheduled_start string (date-time)
maintenance_scheduled_end string (date-time)
maintenance_service_provider string
maintenance_affected_offerings array of objects
maintenance_affected_offerings.uuid string (uuid)
maintenance_affected_offerings.name string
maintenance_affected_offerings.impact_level string
maintenance_affected_offerings.impact_level_display string
maintenance_affected_offerings.impact_description string
maintenance_external_reference_url string

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/admin-announcements/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.admin_announcement_field_enum import AdminAnnouncementFieldEnum # (1)
from waldur_api_client.api.admin_announcements import admin_announcements_retrieve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = admin_announcements_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. Model Source: AdminAnnouncementFieldEnum
  2. API Source: admin_announcements_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { adminAnnouncementsRetrieve } from 'waldur-js-client';

try {
  const response = await adminAnnouncementsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type
field array

200 -

Field Type
uuid string (uuid)
description string
active_from string (date-time)
active_to string (date-time)
is_active boolean
type string
created string (date-time)
maintenance_uuid string
maintenance_name string
maintenance_type string
maintenance_state string
maintenance_scheduled_start string (date-time)
maintenance_scheduled_end string (date-time)
maintenance_service_provider string
maintenance_affected_offerings array of objects
maintenance_affected_offerings.uuid string (uuid)
maintenance_affected_offerings.name string
maintenance_affected_offerings.impact_level string
maintenance_affected_offerings.impact_level_display string
maintenance_affected_offerings.impact_description string
maintenance_external_reference_url string

Create

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/admin-announcements/ \
  Authorization:"Token YOUR_API_TOKEN" \
  active_from="2023-10-01T12:00:00Z" \
  active_to="2023-10-01T12:00:00Z"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.admin_announcement_request import AdminAnnouncementRequest # (1)
from waldur_api_client.api.admin_announcements import admin_announcements_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = AdminAnnouncementRequest(
    active_from="2023-10-01T12:00:00Z",
    active_to="2023-10-01T12:00:00Z"
)
response = admin_announcements_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: AdminAnnouncementRequest
  2. API Source: admin_announcements_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { adminAnnouncementsCreate } from 'waldur-js-client';

try {
  const response = await adminAnnouncementsCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "active_from": "2023-10-01T12:00:00Z",
    "active_to": "2023-10-01T12:00:00Z"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required
description string
active_from string (date-time) ✓
active_to string (date-time) ✓
type string

201 -

Field Type
uuid string (uuid)
description string
active_from string (date-time)
active_to string (date-time)
is_active boolean
type string
created string (date-time)
maintenance_uuid string
maintenance_name string
maintenance_type string
maintenance_state string
maintenance_scheduled_start string (date-time)
maintenance_scheduled_end string (date-time)
maintenance_service_provider string
maintenance_affected_offerings array of objects
maintenance_affected_offerings.uuid string (uuid)
maintenance_affected_offerings.name string
maintenance_affected_offerings.impact_level string
maintenance_affected_offerings.impact_level_display string
maintenance_affected_offerings.impact_description string
maintenance_external_reference_url string

Update

1
2
3
4
5
6
http \
  PUT \
  https://api.example.com/api/admin-announcements/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  active_from="2023-10-01T12:00:00Z" \
  active_to="2023-10-01T12:00:00Z"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.admin_announcement_request import AdminAnnouncementRequest # (1)
from waldur_api_client.api.admin_announcements import admin_announcements_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = AdminAnnouncementRequest(
    active_from="2023-10-01T12:00:00Z",
    active_to="2023-10-01T12:00:00Z"
)
response = admin_announcements_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: AdminAnnouncementRequest
  2. API Source: admin_announcements_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { adminAnnouncementsUpdate } from 'waldur-js-client';

try {
  const response = await adminAnnouncementsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "active_from": "2023-10-01T12:00:00Z",
    "active_to": "2023-10-01T12:00:00Z"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
description string
active_from string (date-time) ✓
active_to string (date-time) ✓
type string

200 -

Field Type
uuid string (uuid)
description string
active_from string (date-time)
active_to string (date-time)
is_active boolean
type string
created string (date-time)
maintenance_uuid string
maintenance_name string
maintenance_type string
maintenance_state string
maintenance_scheduled_start string (date-time)
maintenance_scheduled_end string (date-time)
maintenance_service_provider string
maintenance_affected_offerings array of objects
maintenance_affected_offerings.uuid string (uuid)
maintenance_affected_offerings.name string
maintenance_affected_offerings.impact_level string
maintenance_affected_offerings.impact_level_display string
maintenance_affected_offerings.impact_description string
maintenance_external_reference_url string

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/admin-announcements/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_admin_announcement_request import PatchedAdminAnnouncementRequest # (1)
from waldur_api_client.api.admin_announcements import admin_announcements_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedAdminAnnouncementRequest()
response = admin_announcements_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedAdminAnnouncementRequest
  2. API Source: admin_announcements_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { adminAnnouncementsPartialUpdate } from 'waldur-js-client';

try {
  const response = await adminAnnouncementsPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
description string
active_from string (date-time)
active_to string (date-time)
type string

200 -

Field Type
uuid string (uuid)
description string
active_from string (date-time)
active_to string (date-time)
is_active boolean
type string
created string (date-time)
maintenance_uuid string
maintenance_name string
maintenance_type string
maintenance_state string
maintenance_scheduled_start string (date-time)
maintenance_scheduled_end string (date-time)
maintenance_service_provider string
maintenance_affected_offerings array of objects
maintenance_affected_offerings.uuid string (uuid)
maintenance_affected_offerings.name string
maintenance_affected_offerings.impact_level string
maintenance_affected_offerings.impact_level_display string
maintenance_affected_offerings.impact_description string
maintenance_external_reference_url string

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/admin-announcements/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.admin_announcements import admin_announcements_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = admin_announcements_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: admin_announcements_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { adminAnnouncementsDestroy } from 'waldur-js-client';

try {
  const response = await adminAnnouncementsDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Broadcast Message Templates

Operations Summary

Method Endpoint Description
GET /api/broadcast-message-templates/ List Broadcast Message Templates
GET /api/broadcast-message-templates/{uuid}/ Retrieve
POST /api/broadcast-message-templates/ Create
PUT /api/broadcast-message-templates/{uuid}/ Update
PATCH /api/broadcast-message-templates/{uuid}/ Partial Update
DELETE /api/broadcast-message-templates/{uuid}/ Delete

List Broadcast Message Templates

1
2
3
4
http \
  GET \
  https://api.example.com/api/broadcast-message-templates/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.broadcast_message_templates import broadcast_message_templates_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = broadcast_message_templates_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: broadcast_message_templates_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { broadcastMessageTemplatesList } from 'waldur-js-client';

try {
  const response = await broadcastMessageTemplatesList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
name string
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
url string (uri)
uuid string (uuid)
name string
subject string
body string

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/broadcast-message-templates/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.broadcast_message_templates import broadcast_message_templates_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = broadcast_message_templates_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: broadcast_message_templates_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { broadcastMessageTemplatesRetrieve } from 'waldur-js-client';

try {
  const response = await broadcastMessageTemplatesRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
url string (uri)
uuid string (uuid)
name string
subject string
body string

Create

1
2
3
4
5
6
7
http \
  POST \
  https://api.example.com/api/broadcast-message-templates/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-broadcast-message-template" \
  subject="string-value" \
  body="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.message_template_request import MessageTemplateRequest # (1)
from waldur_api_client.api.broadcast_message_templates import broadcast_message_templates_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = MessageTemplateRequest(
    name="my-awesome-broadcast-message-template",
    subject="string-value",
    body="string-value"
)
response = broadcast_message_templates_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: MessageTemplateRequest
  2. API Source: broadcast_message_templates_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
import { broadcastMessageTemplatesCreate } from 'waldur-js-client';

try {
  const response = await broadcastMessageTemplatesCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "name": "my-awesome-broadcast-message-template",
    "subject": "string-value",
    "body": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required
name string ✓
subject string ✓
body string ✓

201 -

Field Type
url string (uri)
uuid string (uuid)
name string
subject string
body string

Update

1
2
3
4
5
6
7
http \
  PUT \
  https://api.example.com/api/broadcast-message-templates/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-broadcast-message-template" \
  subject="string-value" \
  body="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.message_template_request import MessageTemplateRequest # (1)
from waldur_api_client.api.broadcast_message_templates import broadcast_message_templates_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = MessageTemplateRequest(
    name="my-awesome-broadcast-message-template",
    subject="string-value",
    body="string-value"
)
response = broadcast_message_templates_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: MessageTemplateRequest
  2. API Source: broadcast_message_templates_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
import { broadcastMessageTemplatesUpdate } from 'waldur-js-client';

try {
  const response = await broadcastMessageTemplatesUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-broadcast-message-template",
    "subject": "string-value",
    "body": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
name string ✓
subject string ✓
body string ✓

200 -

Field Type
url string (uri)
uuid string (uuid)
name string
subject string
body string

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/broadcast-message-templates/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_message_template_request import PatchedMessageTemplateRequest # (1)
from waldur_api_client.api.broadcast_message_templates import broadcast_message_templates_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedMessageTemplateRequest()
response = broadcast_message_templates_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedMessageTemplateRequest
  2. API Source: broadcast_message_templates_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { broadcastMessageTemplatesPartialUpdate } from 'waldur-js-client';

try {
  const response = await broadcastMessageTemplatesPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
name string
subject string
body string

200 -

Field Type
url string (uri)
uuid string (uuid)
name string
subject string
body string

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/broadcast-message-templates/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.broadcast_message_templates import broadcast_message_templates_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = broadcast_message_templates_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: broadcast_message_templates_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { broadcastMessageTemplatesDestroy } from 'waldur-js-client';

try {
  const response = await broadcastMessageTemplatesDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Broadcast Messages

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/broadcast-messages/ List Broadcast Messages
GET /api/broadcast-messages/{uuid}/ Retrieve
POST /api/broadcast-messages/ Create
PUT /api/broadcast-messages/{uuid}/ Update
PATCH /api/broadcast-messages/{uuid}/ Partial Update
DELETE /api/broadcast-messages/{uuid}/ Delete
Other Actions
GET /api/broadcast-messages/recipients/ List Broadcast Messages Recipients
POST /api/broadcast-messages/{uuid}/schedule/ Schedule
POST /api/broadcast-messages/{uuid}/send/ Send

Core CRUD

List Broadcast Messages

1
2
3
4
http \
  GET \
  https://api.example.com/api/broadcast-messages/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.broadcast_message_field_enum import BroadcastMessageFieldEnum # (1)
from waldur_api_client.models.broadcast_message_o_enum import BroadcastMessageOEnum # (2)
from waldur_api_client.models.broadcast_message_state_enum import BroadcastMessageStateEnum # (3)
from waldur_api_client.api.broadcast_messages import broadcast_messages_list # (4)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = broadcast_messages_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: BroadcastMessageFieldEnum
  2. Model Source: BroadcastMessageOEnum
  3. Model Source: BroadcastMessageStateEnum
  4. API Source: broadcast_messages_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { broadcastMessagesList } from 'waldur-js-client';

try {
  const response = await broadcastMessagesList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
field array
o array Ordering
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
state string Enum: DRAFT, SCHEDULED, SENT
subject string

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
uuid string (uuid)
created string (date-time)
subject string
body string
query any
author_full_name string
emails any
state any
send_at string (date)

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/broadcast-messages/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.broadcast_message_field_enum import BroadcastMessageFieldEnum # (1)
from waldur_api_client.api.broadcast_messages import broadcast_messages_retrieve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = broadcast_messages_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. Model Source: BroadcastMessageFieldEnum
  2. API Source: broadcast_messages_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { broadcastMessagesRetrieve } from 'waldur-js-client';

try {
  const response = await broadcastMessagesRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type
field array

200 -

Field Type
uuid string (uuid)
created string (date-time)
subject string
body string
query any
author_full_name string
emails any
state any
send_at string (date)

Create

1
2
3
4
5
6
7
http \
  POST \
  https://api.example.com/api/broadcast-messages/ \
  Authorization:"Token YOUR_API_TOKEN" \
  subject="string-value" \
  body="string-value" \
  query=null

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.broadcast_message_request import BroadcastMessageRequest # (1)
from waldur_api_client.api.broadcast_messages import broadcast_messages_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = BroadcastMessageRequest(
    subject="string-value",
    body="string-value",
    query=null
)
response = broadcast_messages_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: BroadcastMessageRequest
  2. API Source: broadcast_messages_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
import { broadcastMessagesCreate } from 'waldur-js-client';

try {
  const response = await broadcastMessagesCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "subject": "string-value",
    "body": "string-value",
    "query": null
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required
subject string ✓
body string ✓
query any ✓
send_at string (date)

201 -

Field Type
uuid string (uuid)
created string (date-time)
subject string
body string
query any
author_full_name string
emails any
state any
send_at string (date)

Update

1
2
3
4
5
6
7
http \
  PUT \
  https://api.example.com/api/broadcast-messages/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  subject="string-value" \
  body="string-value" \
  query=null

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.broadcast_message_request import BroadcastMessageRequest # (1)
from waldur_api_client.api.broadcast_messages import broadcast_messages_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = BroadcastMessageRequest(
    subject="string-value",
    body="string-value",
    query=null
)
response = broadcast_messages_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: BroadcastMessageRequest
  2. API Source: broadcast_messages_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
import { broadcastMessagesUpdate } from 'waldur-js-client';

try {
  const response = await broadcastMessagesUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "subject": "string-value",
    "body": "string-value",
    "query": null
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
subject string ✓
body string ✓
query any ✓
send_at string (date)

200 -

Field Type
uuid string (uuid)
created string (date-time)
subject string
body string
query any
author_full_name string
emails any
state any
send_at string (date)

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/broadcast-messages/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_broadcast_message_request import PatchedBroadcastMessageRequest # (1)
from waldur_api_client.api.broadcast_messages import broadcast_messages_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedBroadcastMessageRequest()
response = broadcast_messages_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedBroadcastMessageRequest
  2. API Source: broadcast_messages_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { broadcastMessagesPartialUpdate } from 'waldur-js-client';

try {
  const response = await broadcastMessagesPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
subject string
body string
query any
send_at string (date)

200 -

Field Type
uuid string (uuid)
created string (date-time)
subject string
body string
query any
author_full_name string
emails any
state any
send_at string (date)

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/broadcast-messages/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.broadcast_messages import broadcast_messages_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = broadcast_messages_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: broadcast_messages_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { broadcastMessagesDestroy } from 'waldur-js-client';

try {
  const response = await broadcastMessagesDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Other Actions

List Broadcast Messages Recipients

1
2
3
4
http \
  GET \
  https://api.example.com/api/broadcast-messages/recipients/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.broadcast_message_field_enum import BroadcastMessageFieldEnum # (1)
from waldur_api_client.api.broadcast_messages import broadcast_messages_recipients_retrieve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = broadcast_messages_recipients_retrieve.sync(client=client)

print(response)
  1. Model Source: BroadcastMessageFieldEnum
  2. API Source: broadcast_messages_recipients_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { broadcastMessagesRecipientsRetrieve } from 'waldur-js-client';

try {
  const response = await broadcastMessagesRecipientsRetrieve({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type
field array

200 -

Field Type
uuid string (uuid)
created string (date-time)
subject string
body string
query any
author_full_name string
emails any
state any
send_at string (date)

Schedule

1
2
3
4
http \
  POST \
  https://api.example.com/api/broadcast-messages/a1b2c3d4-e5f6-7890-abcd-ef1234567890/schedule/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.broadcast_messages import broadcast_messages_schedule # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = broadcast_messages_schedule.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: broadcast_messages_schedule
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { broadcastMessagesSchedule } from 'waldur-js-client';

try {
  const response = await broadcastMessagesSchedule({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 - No response body

Send

1
2
3
4
http \
  POST \
  https://api.example.com/api/broadcast-messages/a1b2c3d4-e5f6-7890-abcd-ef1234567890/send/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.broadcast_messages import broadcast_messages_send # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = broadcast_messages_send.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: broadcast_messages_send
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { broadcastMessagesSend } from 'waldur-js-client';

try {
  const response = await broadcastMessagesSend({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 - No response body

Data Access Logs

Operations Summary

Method Endpoint Description
GET /api/data-access-logs/ List Data Access Logs
GET /api/data-access-logs/{uuid}/ Retrieve
DELETE /api/data-access-logs/{uuid}/ Delete

List Data Access Logs

1
2
3
4
http \
  GET \
  https://api.example.com/api/data-access-logs/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.accessor_type_enum import AccessorTypeEnum # (1)
from waldur_api_client.models.global_user_data_access_log_o_enum import GlobalUserDataAccessLogOEnum # (2)
from waldur_api_client.api.data_access_logs import data_access_logs_list # (3)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = data_access_logs_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: AccessorTypeEnum
  2. Model Source: GlobalUserDataAccessLogOEnum
  3. API Source: data_access_logs_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { dataAccessLogsList } from 'waldur-js-client';

try {
  const response = await dataAccessLogsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
accessor_type string Type of accessor


Enum: staff, support, organization_member, service_provider, self
accessor_uuid string (uuid)
end_date string (date)
o array Ordering
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
query string
start_date string (date)
user_uuid string (uuid)

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid)
timestamp string (date-time)
accessor_type string
Enum: staff, support, organization_member, service_provider, self
accessed_fields array of strings
user object
user.uuid string (uuid)
user.username string
user.full_name string
accessor object
accessor.uuid string (uuid)
accessor.username string
accessor.full_name string
ip_address any An IPv4 or IPv6 address.
context object (free-form)

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/data-access-logs/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.data_access_logs import data_access_logs_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = data_access_logs_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: data_access_logs_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { dataAccessLogsRetrieve } from 'waldur-js-client';

try {
  const response = await dataAccessLogsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
uuid string (uuid)
timestamp string (date-time)
accessor_type string
Enum: staff, support, organization_member, service_provider, self
accessed_fields array of strings
user object
user.uuid string (uuid)
user.username string
user.full_name string
accessor object
accessor.uuid string (uuid)
accessor.username string
accessor.full_name string
ip_address any An IPv4 or IPv6 address.
context object (free-form)

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/data-access-logs/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.data_access_logs import data_access_logs_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = data_access_logs_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: data_access_logs_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { dataAccessLogsDestroy } from 'waldur-js-client';

try {
  const response = await dataAccessLogsDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Email Logs

Operations Summary

Method Endpoint Description
GET /api/email-logs/ List Email Logs
GET /api/email-logs/{uuid}/ Retrieve

List Email Logs

1
2
3
4
http \
  GET \
  https://api.example.com/api/email-logs/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.email_log_o_enum import EmailLogOEnum # (1)
from waldur_api_client.api.email_logs import email_logs_list # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = email_logs_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: EmailLogOEnum
  2. API Source: email_logs_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { emailLogsList } from 'waldur-js-client';

try {
  const response = await emailLogsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
body string
emails string
o array Ordering
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
sent_at string (date)
subject string

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
uuid string (uuid)
url string (uri)
sent_at string (date-time)
subject string
body string
emails array of string (email)s

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/email-logs/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.email_logs import email_logs_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = email_logs_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: email_logs_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { emailLogsRetrieve } from 'waldur-js-client';

try {
  const response = await emailLogsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
uuid string (uuid)
url string (uri)
sent_at string (date-time)
subject string
body string
emails array of string (email)s

Event Subscription Queues

Operations Summary

Method Endpoint Description
GET /api/event-subscription-queues/ List Event Subscription Queues
GET /api/event-subscription-queues/{uuid}/ Retrieve
DELETE /api/event-subscription-queues/{uuid}/ Delete

List Event Subscription Queues

1
2
3
4
http \
  GET \
  https://api.example.com/api/event-subscription-queues/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.backend_resource_req_o_enum import BackendResourceReqOEnum # (1)
from waldur_api_client.api.event_subscription_queues import event_subscription_queues_list # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = event_subscription_queues_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: BackendResourceReqOEnum
  2. API Source: event_subscription_queues_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { eventSubscriptionQueuesList } from 'waldur-js-client';

try {
  const response = await eventSubscriptionQueuesList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
event_subscription_uuid string (uuid)
o array Ordering
object_type string
offering_uuid string (uuid)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid)
url string (uri)
event_subscription string (uri)
event_subscription_uuid string
offering_uuid string
object_type string Observable object type (e.g., 'resource', 'order')
queue_name string
vhost string
created string (date-time)

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/event-subscription-queues/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.event_subscription_queues import event_subscription_queues_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = event_subscription_queues_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: event_subscription_queues_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { eventSubscriptionQueuesRetrieve } from 'waldur-js-client';

try {
  const response = await eventSubscriptionQueuesRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
uuid string (uuid)
url string (uri)
event_subscription string (uri)
event_subscription_uuid string
offering_uuid string
object_type string Observable object type (e.g., 'resource', 'order')
queue_name string
vhost string
created string (date-time)

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/event-subscription-queues/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.event_subscription_queues import event_subscription_queues_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = event_subscription_queues_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: event_subscription_queues_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { eventSubscriptionQueuesDestroy } from 'waldur-js-client';

try {
  const response = await eventSubscriptionQueuesDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Event Subscriptions

Operations Summary

Method Endpoint Description
GET /api/event-subscriptions/ List Event Subscriptions
GET /api/event-subscriptions/{uuid}/ Retrieve
POST /api/event-subscriptions/ Create
POST /api/event-subscriptions/{uuid}/create_queue/ Create queue
DELETE /api/event-subscriptions/{uuid}/ Delete

List Event Subscriptions

1
2
3
4
http \
  GET \
  https://api.example.com/api/event-subscriptions/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.backend_resource_req_o_enum import BackendResourceReqOEnum # (1)
from waldur_api_client.api.event_subscriptions import event_subscriptions_list # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = event_subscriptions_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: BackendResourceReqOEnum
  2. API Source: event_subscriptions_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { eventSubscriptionsList } from 'waldur-js-client';

try {
  const response = await eventSubscriptionsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
o array Ordering
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
user_username string
user_uuid string

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid)
url string (uri)
description string
user string (uri)
user_uuid string (uuid)
user_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
user_full_name string
observable_objects any List of objects to observe. Each item must have 'object_type' (one of: order, user_role, resource, offering_user, importable_resources, service_account, course_account, resource_periodic_limits) and optionally 'object_id' (integer). Example: [{"object_type": "resource"}, {"object_type": "order", "object_id": 123}]
created string (date-time)
modified string (date-time)
source_ip any An IPv4 or IPv6 address.

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/event-subscriptions/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.event_subscriptions import event_subscriptions_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = event_subscriptions_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: event_subscriptions_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { eventSubscriptionsRetrieve } from 'waldur-js-client';

try {
  const response = await eventSubscriptionsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
uuid string (uuid)
url string (uri)
description string
user string (uri)
user_uuid string (uuid)
user_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
user_full_name string
observable_objects any List of objects to observe. Each item must have 'object_type' (one of: order, user_role, resource, offering_user, importable_resources, service_account, course_account, resource_periodic_limits) and optionally 'object_id' (integer). Example: [{"object_type": "resource"}, {"object_type": "order", "object_id": 123}]
created string (date-time)
modified string (date-time)
source_ip any An IPv4 or IPv6 address.

Create

1
2
3
4
http \
  POST \
  https://api.example.com/api/event-subscriptions/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.event_subscription_request import EventSubscriptionRequest # (1)
from waldur_api_client.api.event_subscriptions import event_subscriptions_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = EventSubscriptionRequest()
response = event_subscriptions_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: EventSubscriptionRequest
  2. API Source: event_subscriptions_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { eventSubscriptionsCreate } from 'waldur-js-client';

try {
  const response = await eventSubscriptionsCreate({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
description string
observable_objects any List of objects to observe. Each item must have 'object_type' (one of: order, user_role, resource, offering_user, importable_resources, service_account, course_account, resource_periodic_limits) and optionally 'object_id' (integer). Example: [{"object_type": "resource"}, {"object_type": "order", "object_id": 123}]

201 -

Field Type Description
uuid string (uuid)
url string (uri)
description string
user string (uri)
user_uuid string (uuid)
user_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
user_full_name string
observable_objects any List of objects to observe. Each item must have 'object_type' (one of: order, user_role, resource, offering_user, importable_resources, service_account, course_account, resource_periodic_limits) and optionally 'object_id' (integer). Example: [{"object_type": "resource"}, {"object_type": "order", "object_id": 123}]
created string (date-time)
modified string (date-time)
source_ip any An IPv4 or IPv6 address.

Create queue

Create a RabbitMQ queue for receiving events for a specific offering and object type. The receiver must call this endpoint before subscribing via STOMP to ensure the queue is created with correct arguments (DLX, max-length, etc.).

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/event-subscriptions/a1b2c3d4-e5f6-7890-abcd-ef1234567890/create_queue/ \
  Authorization:"Token YOUR_API_TOKEN" \
  offering_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  object_type=null

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.event_subscription_queue_create_request import EventSubscriptionQueueCreateRequest # (1)
from waldur_api_client.api.event_subscriptions import event_subscriptions_create_queue # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = EventSubscriptionQueueCreateRequest(
    offering_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    object_type=null
)
response = event_subscriptions_create_queue.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: EventSubscriptionQueueCreateRequest
  2. API Source: event_subscriptions_create_queue
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { eventSubscriptionsCreateQueue } from 'waldur-js-client';

try {
  const response = await eventSubscriptionsCreateQueue({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "offering_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "object_type": null
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
offering_uuid string (uuid) ✓ UUID of the offering to receive events for
object_type any ✓ Type of observable object (e.g., 'resource', 'order')

200 -

Field Type Description
uuid string (uuid)
url string (uri)
event_subscription string (uri)
event_subscription_uuid string
offering_uuid string
object_type string Observable object type (e.g., 'resource', 'order')
queue_name string
vhost string
created string (date-time)

201 -

Field Type Description
uuid string (uuid)
url string (uri)
event_subscription string (uri)
event_subscription_uuid string
offering_uuid string
object_type string Observable object type (e.g., 'resource', 'order')
queue_name string
vhost string
created string (date-time)

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/event-subscriptions/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.event_subscriptions import event_subscriptions_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = event_subscriptions_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: event_subscriptions_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { eventSubscriptionsDestroy } from 'waldur-js-client';

try {
  const response = await eventSubscriptionsDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Events Stats

Operations Summary

Method Endpoint Description
GET /api/events-stats/ List Events Stats

List Events Stats

1
2
3
4
http \
  GET \
  https://api.example.com/api/events-stats/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.events_stats import events_stats_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = events_stats_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: events_stats_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { eventsStatsList } from 'waldur-js-client';

try {
  const response = await eventsStatsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
event_type array Filter by event type. Can be specified multiple times.
feature array Filter by feature (event group). Can be specified multiple times.
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
scope string (uri) Filter by scope URL.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
year integer
month integer
count integer

Events

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/events/ List Events
GET /api/events/{id}/ Retrieve
Other Actions
GET /api/events/count/ List Events Count
GET /api/events/event_groups/ Returns a list of groups with event types
GET /api/events/scope_types/ Returns a list of scope types acceptable by events filter

Core CRUD

List Events

1
2
3
4
http \
  GET \
  https://api.example.com/api/events/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.backend_resource_req_o_enum import BackendResourceReqOEnum # (1)
from waldur_api_client.models.event_field_enum import EventFieldEnum # (2)
from waldur_api_client.api.events import events_list # (3)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = events_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: BackendResourceReqOEnum
  2. Model Source: EventFieldEnum
  3. API Source: events_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { eventsList } from 'waldur-js-client';

try {
  const response = await eventsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
created_from number
created_to number
customer_uuid string (uuid) Customer UUID
event_type array Filter by event type. Can be specified multiple times.
feature array Filter by feature (event group). Can be specified multiple times.
field array
message string
o array Ordering
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
project_uuid string (uuid) Project UUID
scope string (uri) Filter by scope URL.
user_uuid string (uuid) User UUID

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
uuid string (uuid)
created string (date-time)
event_type string
message string
context any

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/events/123/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.event_field_enum import EventFieldEnum # (1)
from waldur_api_client.api.events import events_retrieve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = events_retrieve.sync(
    id=123,
    client=client
)

print(response)
  1. Model Source: EventFieldEnum
  2. API Source: events_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { eventsRetrieve } from 'waldur-js-client';

try {
  const response = await eventsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "id": 123
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
id integer ✓ A unique integer value identifying this event.
Name Type
field array

200 -

Field Type
uuid string (uuid)
created string (date-time)
event_type string
message string
context any

Other Actions

List Events Count

1
2
3
4
http \
  GET \
  https://api.example.com/api/events/count/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.event_field_enum import EventFieldEnum # (1)
from waldur_api_client.api.events import events_count_retrieve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = events_count_retrieve.sync(client=client)

print(response)
  1. Model Source: EventFieldEnum
  2. API Source: events_count_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { eventsCountRetrieve } from 'waldur-js-client';

try {
  const response = await eventsCountRetrieve({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type
field array

200 -

Field Type
uuid string (uuid)
created string (date-time)
event_type string
message string
context any

Returns a list of groups with event types

Returns a list of groups with event types. Group is used in exclude_features query param.

1
2
3
4
http \
  GET \
  https://api.example.com/api/events/event_groups/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.event_field_enum import EventFieldEnum # (1)
from waldur_api_client.api.events import events_event_groups_retrieve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = events_event_groups_retrieve.sync(client=client)

print(response)
  1. Model Source: EventFieldEnum
  2. API Source: events_event_groups_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { eventsEventGroupsRetrieve } from 'waldur-js-client';

try {
  const response = await eventsEventGroupsRetrieve({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type
field array

200 -

Field Type
uuid string (uuid)
created string (date-time)
event_type string
message string
context any

Returns a list of scope types acceptable by events filter

Returns a list of scope types acceptable by events filter.

1
2
3
4
http \
  GET \
  https://api.example.com/api/events/scope_types/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.event_field_enum import EventFieldEnum # (1)
from waldur_api_client.api.events import events_scope_types_retrieve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = events_scope_types_retrieve.sync(client=client)

print(response)
  1. Model Source: EventFieldEnum
  2. API Source: events_scope_types_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { eventsScopeTypesRetrieve } from 'waldur-js-client';

try {
  const response = await eventsScopeTypesRetrieve({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type
field array

200 -

Field Type
uuid string (uuid)
created string (date-time)
event_type string
message string
context any

Hooks Email

Operations Summary

Method Endpoint Description
GET /api/hooks-email/ List Hooks Email
GET /api/hooks-email/{uuid}/ Retrieve
POST /api/hooks-email/ Create
PUT /api/hooks-email/{uuid}/ Update
PATCH /api/hooks-email/{uuid}/ Partial Update
DELETE /api/hooks-email/{uuid}/ Delete

List Hooks Email

1
2
3
4
http \
  GET \
  https://api.example.com/api/hooks-email/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.hooks_email import hooks_email_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = hooks_email_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: hooks_email_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { hooksEmailList } from 'waldur-js-client';

try {
  const response = await hooksEmailList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
author_email string
author_fullname string User full name contains
author_username string
author_uuid string (uuid)
email string
is_active boolean
last_published string (date-time)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
query string Filter by author name, username and email

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
url string (uri)
uuid string (uuid)
is_active boolean
author_uuid string (uuid)
event_types array of strings
event_groups array of strings
created string (date-time)
modified string (date-time)
hook_type string
author_fullname string
author_username string
author_email string
email string (email)

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/hooks-email/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.hooks_email import hooks_email_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = hooks_email_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: hooks_email_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { hooksEmailRetrieve } from 'waldur-js-client';

try {
  const response = await hooksEmailRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
url string (uri)
uuid string (uuid)
is_active boolean
author_uuid string (uuid)
event_types array of strings
event_groups array of strings
created string (date-time)
modified string (date-time)
hook_type string
author_fullname string
author_username string
author_email string
email string (email)

Create

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/hooks-email/ \
  Authorization:"Token YOUR_API_TOKEN" \
  email="alice@example.com"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.email_hook_request import EmailHookRequest # (1)
from waldur_api_client.api.hooks_email import hooks_email_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = EmailHookRequest(
    email="alice@example.com"
)
response = hooks_email_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: EmailHookRequest
  2. API Source: hooks_email_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { hooksEmailCreate } from 'waldur-js-client';

try {
  const response = await hooksEmailCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "email": "alice@example.com"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required
is_active boolean
event_types array of strings
event_groups array of strings
email string (email) ✓

201 -

Field Type
url string (uri)
uuid string (uuid)
is_active boolean
author_uuid string (uuid)
event_types array of strings
event_groups array of strings
created string (date-time)
modified string (date-time)
hook_type string
author_fullname string
author_username string
author_email string
email string (email)

Update

1
2
3
4
5
http \
  PUT \
  https://api.example.com/api/hooks-email/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  email="alice@example.com"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.email_hook_request import EmailHookRequest # (1)
from waldur_api_client.api.hooks_email import hooks_email_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = EmailHookRequest(
    email="alice@example.com"
)
response = hooks_email_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: EmailHookRequest
  2. API Source: hooks_email_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { hooksEmailUpdate } from 'waldur-js-client';

try {
  const response = await hooksEmailUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "email": "alice@example.com"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
is_active boolean
event_types array of strings
event_groups array of strings
email string (email) ✓

200 -

Field Type
url string (uri)
uuid string (uuid)
is_active boolean
author_uuid string (uuid)
event_types array of strings
event_groups array of strings
created string (date-time)
modified string (date-time)
hook_type string
author_fullname string
author_username string
author_email string
email string (email)

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/hooks-email/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_email_hook_request import PatchedEmailHookRequest # (1)
from waldur_api_client.api.hooks_email import hooks_email_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedEmailHookRequest()
response = hooks_email_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedEmailHookRequest
  2. API Source: hooks_email_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { hooksEmailPartialUpdate } from 'waldur-js-client';

try {
  const response = await hooksEmailPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
is_active boolean
event_types array of strings
event_groups array of strings
email string (email)

200 -

Field Type
url string (uri)
uuid string (uuid)
is_active boolean
author_uuid string (uuid)
event_types array of strings
event_groups array of strings
created string (date-time)
modified string (date-time)
hook_type string
author_fullname string
author_username string
author_email string
email string (email)

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/hooks-email/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.hooks_email import hooks_email_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = hooks_email_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: hooks_email_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { hooksEmailDestroy } from 'waldur-js-client';

try {
  const response = await hooksEmailDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Hooks Web

Operations Summary

Method Endpoint Description
GET /api/hooks-web/ List Hooks Web
GET /api/hooks-web/{uuid}/ Retrieve
POST /api/hooks-web/ Create
PUT /api/hooks-web/{uuid}/ Update
PATCH /api/hooks-web/{uuid}/ Partial Update
DELETE /api/hooks-web/{uuid}/ Delete

List Hooks Web

1
2
3
4
http \
  GET \
  https://api.example.com/api/hooks-web/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.web_hook_content_type_enum1 import WebHookContentTypeEnum1 # (1)
from waldur_api_client.api.hooks_web import hooks_web_list # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = hooks_web_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: WebHookContentTypeEnum1
  2. API Source: hooks_web_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { hooksWebList } from 'waldur-js-client';

try {
  const response = await hooksWebList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
author_email string
author_fullname string User full name contains
author_username string
author_uuid string (uuid)
content_type string Enum: 1, 2
destination_url string
is_active boolean
last_published string (date-time)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
query string Filter by author name, username and email

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
url string (uri)
uuid string (uuid)
is_active boolean
author_uuid string (uuid)
event_types array of strings
event_groups array of strings
created string (date-time)
modified string (date-time)
hook_type string
author_fullname string
author_username string
author_email string
destination_url string (uri)
content_type string

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/hooks-web/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.hooks_web import hooks_web_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = hooks_web_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: hooks_web_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { hooksWebRetrieve } from 'waldur-js-client';

try {
  const response = await hooksWebRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
url string (uri)
uuid string (uuid)
is_active boolean
author_uuid string (uuid)
event_types array of strings
event_groups array of strings
created string (date-time)
modified string (date-time)
hook_type string
author_fullname string
author_username string
author_email string
destination_url string (uri)
content_type string

Create

When hook is activated, POST request is issued against destination URL with the following data:

.. code-block:: javascript

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
{
    "timestamp": "2015-07-14T12:12:56.000000",
    "message": "Customer ABC LLC has been updated.",
    "type": "customer_update_succeeded",
    "context": {
        "user_native_name": "Walter Lebrowski",
        "customer_contact_details": "",
        "user_username": "Walter",
        "user_uuid": "1c3323fc4ae44120b57ec40dea1be6e6",
        "customer_uuid": "4633bbbb0b3a4b91bffc0e18f853de85",
        "ip_address": "8.8.8.8",
        "user_full_name": "Walter Lebrowski",
        "customer_abbreviation": "ABC LLC",
        "customer_name": "ABC LLC"
    },
    "levelname": "INFO"
}

Note that context depends on event type.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/hooks-web/ \
  Authorization:"Token YOUR_API_TOKEN" \
  destination_url="https://api.example.com/api/destination-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.web_hook_request import WebHookRequest # (1)
from waldur_api_client.api.hooks_web import hooks_web_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = WebHookRequest(
    destination_url="https://api.example.com/api/destination-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = hooks_web_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: WebHookRequest
  2. API Source: hooks_web_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { hooksWebCreate } from 'waldur-js-client';

try {
  const response = await hooksWebCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "destination_url": "https://api.example.com/api/destination-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required
is_active boolean
event_types array of strings
event_groups array of strings
destination_url string (uri) ✓
content_type string

201 -

Field Type
url string (uri)
uuid string (uuid)
is_active boolean
author_uuid string (uuid)
event_types array of strings
event_groups array of strings
created string (date-time)
modified string (date-time)
hook_type string
author_fullname string
author_username string
author_email string
destination_url string (uri)
content_type string

Update

1
2
3
4
5
http \
  PUT \
  https://api.example.com/api/hooks-web/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  destination_url="https://api.example.com/api/destination-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.web_hook_request import WebHookRequest # (1)
from waldur_api_client.api.hooks_web import hooks_web_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = WebHookRequest(
    destination_url="https://api.example.com/api/destination-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = hooks_web_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: WebHookRequest
  2. API Source: hooks_web_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { hooksWebUpdate } from 'waldur-js-client';

try {
  const response = await hooksWebUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "destination_url": "https://api.example.com/api/destination-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
is_active boolean
event_types array of strings
event_groups array of strings
destination_url string (uri) ✓
content_type string

200 -

Field Type
url string (uri)
uuid string (uuid)
is_active boolean
author_uuid string (uuid)
event_types array of strings
event_groups array of strings
created string (date-time)
modified string (date-time)
hook_type string
author_fullname string
author_username string
author_email string
destination_url string (uri)
content_type string

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/hooks-web/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_web_hook_request import PatchedWebHookRequest # (1)
from waldur_api_client.api.hooks_web import hooks_web_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedWebHookRequest()
response = hooks_web_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedWebHookRequest
  2. API Source: hooks_web_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { hooksWebPartialUpdate } from 'waldur-js-client';

try {
  const response = await hooksWebPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
is_active boolean
event_types array of strings
event_groups array of strings
destination_url string (uri)
content_type string

200 -

Field Type
url string (uri)
uuid string (uuid)
is_active boolean
author_uuid string (uuid)
event_types array of strings
event_groups array of strings
created string (date-time)
modified string (date-time)
hook_type string
author_fullname string
author_username string
author_email string
destination_url string (uri)
content_type string

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/hooks-web/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.hooks_web import hooks_web_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = hooks_web_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: hooks_web_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { hooksWebDestroy } from 'waldur-js-client';

try {
  const response = await hooksWebDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Hooks

Operations Summary

Method Endpoint Description
GET /api/hooks/ List Hooks

List Hooks

1
2
3
4
http \
  GET \
  https://api.example.com/api/hooks/ \
  Authorization:"Token YOUR_API_TOKEN"

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.hooks import hooks_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = hooks_list.sync(client=client)

print(response)
  1. API Source: hooks_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { hooksList } from 'waldur-js-client';

try {
  const response = await hooksList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
author_uuid string (uuid) Filter by author UUID.
is_active boolean Filter by active status.
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 - No response body

Notification Messages Templates

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/notification-messages-templates/ List Notification Messages Templates
GET /api/notification-messages-templates/{uuid}/ Retrieve
POST /api/notification-messages-templates/ Create
PUT /api/notification-messages-templates/{uuid}/ Update
PATCH /api/notification-messages-templates/{uuid}/ Partial Update
DELETE /api/notification-messages-templates/{uuid}/ Delete
Other Actions
POST /api/notification-messages-templates/{uuid}/override/ Override notification template content

Core CRUD

List Notification Messages Templates

1
2
3
4
http \
  GET \
  https://api.example.com/api/notification-messages-templates/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.notification_messages_templates import notification_messages_templates_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = notification_messages_templates_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: notification_messages_templates_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { notificationMessagesTemplatesList } from 'waldur-js-client';

try {
  const response = await notificationMessagesTemplatesList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
is_overridden boolean Is overridden
name string Name
name_exact string Name (exact)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
path string Path
path_exact string Path (exact)

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid)
url string (uri)
path string Example: 'flatpages/default.html'
name string
content string
original_content string
is_content_overridden boolean

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/notification-messages-templates/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.notification_messages_templates import notification_messages_templates_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = notification_messages_templates_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: notification_messages_templates_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { notificationMessagesTemplatesRetrieve } from 'waldur-js-client';

try {
  const response = await notificationMessagesTemplatesRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
uuid string (uuid)
url string (uri)
path string Example: 'flatpages/default.html'
name string
content string
original_content string
is_content_overridden boolean

Create

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/notification-messages-templates/ \
  Authorization:"Token YOUR_API_TOKEN" \
  path="string-value" \
  name="my-awesome-notification-messages-template"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.notification_template_detail_serializers_request import NotificationTemplateDetailSerializersRequest # (1)
from waldur_api_client.api.notification_messages_templates import notification_messages_templates_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = NotificationTemplateDetailSerializersRequest(
    path="string-value",
    name="my-awesome-notification-messages-template"
)
response = notification_messages_templates_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: NotificationTemplateDetailSerializersRequest
  2. API Source: notification_messages_templates_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { notificationMessagesTemplatesCreate } from 'waldur-js-client';

try {
  const response = await notificationMessagesTemplatesCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "path": "string-value",
    "name": "my-awesome-notification-messages-template"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
path string ✓ Example: 'flatpages/default.html'
name string ✓

201 -

Field Type Description
uuid string (uuid)
url string (uri)
path string Example: 'flatpages/default.html'
name string
content string
original_content string
is_content_overridden boolean

Update

1
2
3
4
5
6
http \
  PUT \
  https://api.example.com/api/notification-messages-templates/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  path="string-value" \
  name="my-awesome-notification-messages-template"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.notification_template_detail_serializers_request import NotificationTemplateDetailSerializersRequest # (1)
from waldur_api_client.api.notification_messages_templates import notification_messages_templates_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = NotificationTemplateDetailSerializersRequest(
    path="string-value",
    name="my-awesome-notification-messages-template"
)
response = notification_messages_templates_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: NotificationTemplateDetailSerializersRequest
  2. API Source: notification_messages_templates_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { notificationMessagesTemplatesUpdate } from 'waldur-js-client';

try {
  const response = await notificationMessagesTemplatesUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "path": "string-value",
    "name": "my-awesome-notification-messages-template"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
path string ✓ Example: 'flatpages/default.html'
name string ✓

200 -

Field Type Description
uuid string (uuid)
url string (uri)
path string Example: 'flatpages/default.html'
name string
content string
original_content string
is_content_overridden boolean

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/notification-messages-templates/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_notification_template_detail_serializers_request import PatchedNotificationTemplateDetailSerializersRequest # (1)
from waldur_api_client.api.notification_messages_templates import notification_messages_templates_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedNotificationTemplateDetailSerializersRequest()
response = notification_messages_templates_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedNotificationTemplateDetailSerializersRequest
  2. API Source: notification_messages_templates_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { notificationMessagesTemplatesPartialUpdate } from 'waldur-js-client';

try {
  const response = await notificationMessagesTemplatesPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
path string Example: 'flatpages/default.html'
name string

200 -

Field Type Description
uuid string (uuid)
url string (uri)
path string Example: 'flatpages/default.html'
name string
content string
original_content string
is_content_overridden boolean

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/notification-messages-templates/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.notification_messages_templates import notification_messages_templates_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = notification_messages_templates_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: notification_messages_templates_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { notificationMessagesTemplatesDestroy } from 'waldur-js-client';

try {
  const response = await notificationMessagesTemplatesDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Other Actions

Override notification template content

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/notification-messages-templates/a1b2c3d4-e5f6-7890-abcd-ef1234567890/override/ \
  Authorization:"Token YOUR_API_TOKEN" \
  content="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.notification_template_update_serializers_request import NotificationTemplateUpdateSerializersRequest # (1)
from waldur_api_client.api.notification_messages_templates import notification_messages_templates_override # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = NotificationTemplateUpdateSerializersRequest(
    content="string-value"
)
response = notification_messages_templates_override.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: NotificationTemplateUpdateSerializersRequest
  2. API Source: notification_messages_templates_override
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { notificationMessagesTemplatesOverride } from 'waldur-js-client';

try {
  const response = await notificationMessagesTemplatesOverride({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "content": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
content string ✓

200 - No response body

Notification Messages

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/notification-messages/ List Notification Messages
GET /api/notification-messages/{uuid}/ Retrieve
POST /api/notification-messages/ Create
PUT /api/notification-messages/{uuid}/ Update
PATCH /api/notification-messages/{uuid}/ Partial Update
DELETE /api/notification-messages/{uuid}/ Delete
Other Actions
POST /api/notification-messages/{uuid}/disable/ Disable a notification
POST /api/notification-messages/{uuid}/enable/ Enable a notification

Core CRUD

List Notification Messages

1
2
3
4
http \
  GET \
  https://api.example.com/api/notification-messages/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.notification_messages import notification_messages_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = notification_messages_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: notification_messages_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { notificationMessagesList } from 'waldur-js-client';

try {
  const response = await notificationMessagesList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
description string
is_overridden boolean Is overridden
key string
name string Name
name_exact string Name (exact)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
query string Filter by key or description

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid)
url string (uri)
key string
description string
enabled boolean Indicates if notification is enabled or disabled
created string (date-time)
templates array of objects
templates.uuid string (uuid)
templates.url string (uri)
templates.path string Example: 'flatpages/default.html'
templates.name string
templates.content string
templates.original_content string
templates.is_content_overridden boolean
context_schema object (free-form) Finds the notification definition in the global NOTIFICATIONS dictionary and returns its 'context' schema.

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/notification-messages/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.notification_messages import notification_messages_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = notification_messages_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: notification_messages_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { notificationMessagesRetrieve } from 'waldur-js-client';

try {
  const response = await notificationMessagesRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
uuid string (uuid)
url string (uri)
key string
description string
enabled boolean Indicates if notification is enabled or disabled
created string (date-time)
templates array of objects
templates.uuid string (uuid)
templates.url string (uri)
templates.path string Example: 'flatpages/default.html'
templates.name string
templates.content string
templates.original_content string
templates.is_content_overridden boolean
context_schema object (free-form) Finds the notification definition in the global NOTIFICATIONS dictionary and returns its 'context' schema.

Create

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/notification-messages/ \
  Authorization:"Token YOUR_API_TOKEN" \
  key="ssh-rsa AAAAB3NzaC1yc2EAAA..."

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.notification_request import NotificationRequest # (1)
from waldur_api_client.api.notification_messages import notification_messages_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = NotificationRequest(
    key="ssh-rsa AAAAB3NzaC1yc2EAAA..."
)
response = notification_messages_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: NotificationRequest
  2. API Source: notification_messages_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { notificationMessagesCreate } from 'waldur-js-client';

try {
  const response = await notificationMessagesCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "key": "ssh-rsa AAAAB3NzaC1yc2EAAA..."
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required
key string ✓
description string

201 -

Field Type Description
uuid string (uuid)
url string (uri)
key string
description string
enabled boolean Indicates if notification is enabled or disabled
created string (date-time)
templates array of objects
templates.uuid string (uuid)
templates.url string (uri)
templates.path string Example: 'flatpages/default.html'
templates.name string
templates.content string
templates.original_content string
templates.is_content_overridden boolean
context_schema object (free-form) Finds the notification definition in the global NOTIFICATIONS dictionary and returns its 'context' schema.

Update

1
2
3
4
5
http \
  PUT \
  https://api.example.com/api/notification-messages/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  key="ssh-rsa AAAAB3NzaC1yc2EAAA..."

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.notification_request import NotificationRequest # (1)
from waldur_api_client.api.notification_messages import notification_messages_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = NotificationRequest(
    key="ssh-rsa AAAAB3NzaC1yc2EAAA..."
)
response = notification_messages_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: NotificationRequest
  2. API Source: notification_messages_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { notificationMessagesUpdate } from 'waldur-js-client';

try {
  const response = await notificationMessagesUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "key": "ssh-rsa AAAAB3NzaC1yc2EAAA..."
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
key string ✓
description string

200 -

Field Type Description
uuid string (uuid)
url string (uri)
key string
description string
enabled boolean Indicates if notification is enabled or disabled
created string (date-time)
templates array of objects
templates.uuid string (uuid)
templates.url string (uri)
templates.path string Example: 'flatpages/default.html'
templates.name string
templates.content string
templates.original_content string
templates.is_content_overridden boolean
context_schema object (free-form) Finds the notification definition in the global NOTIFICATIONS dictionary and returns its 'context' schema.

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/notification-messages/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_notification_request import PatchedNotificationRequest # (1)
from waldur_api_client.api.notification_messages import notification_messages_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedNotificationRequest()
response = notification_messages_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedNotificationRequest
  2. API Source: notification_messages_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { notificationMessagesPartialUpdate } from 'waldur-js-client';

try {
  const response = await notificationMessagesPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
key string
description string

200 -

Field Type Description
uuid string (uuid)
url string (uri)
key string
description string
enabled boolean Indicates if notification is enabled or disabled
created string (date-time)
templates array of objects
templates.uuid string (uuid)
templates.url string (uri)
templates.path string Example: 'flatpages/default.html'
templates.name string
templates.content string
templates.original_content string
templates.is_content_overridden boolean
context_schema object (free-form) Finds the notification definition in the global NOTIFICATIONS dictionary and returns its 'context' schema.

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/notification-messages/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.notification_messages import notification_messages_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = notification_messages_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: notification_messages_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { notificationMessagesDestroy } from 'waldur-js-client';

try {
  const response = await notificationMessagesDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Other Actions

Disable a notification

1
2
3
4
http \
  POST \
  https://api.example.com/api/notification-messages/a1b2c3d4-e5f6-7890-abcd-ef1234567890/disable/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.notification_messages import notification_messages_disable # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = notification_messages_disable.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: notification_messages_disable
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { notificationMessagesDisable } from 'waldur-js-client';

try {
  const response = await notificationMessagesDisable({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 - No response body

Enable a notification

1
2
3
4
http \
  POST \
  https://api.example.com/api/notification-messages/a1b2c3d4-e5f6-7890-abcd-ef1234567890/enable/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.notification_messages import notification_messages_enable # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = notification_messages_enable.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: notification_messages_enable
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { notificationMessagesEnable } from 'waldur-js-client';

try {
  const response = await notificationMessagesEnable({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 - No response body

Rabbitmq Overview

Operations Summary

Method Endpoint Description
GET /api/rabbitmq-overview/ Get RabbitMQ cluster overview statistics

Get RabbitMQ cluster overview statistics

Returns global RabbitMQ cluster health and performance metrics.

Includes: - Cluster info: Name, RabbitMQ version, Erlang version - Message stats: Publish/deliver/confirm/ack counts and rates (per second) - Queue totals: Total messages, ready messages, unacknowledged messages - Object totals: Connection, channel, exchange, queue, and consumer counts - Listeners: Active protocol listeners (AMQP, HTTP, etc.)

Requires support user permissions.

1
2
3
4
http \
  GET \
  https://api.example.com/api/rabbitmq-overview/ \
  Authorization:"Token YOUR_API_TOKEN"

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.rabbitmq_overview import rabbitmq_overview_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = rabbitmq_overview_retrieve.sync(client=client)

print(response)
  1. API Source: rabbitmq_overview_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { rabbitmqOverviewRetrieve } from 'waldur-js-client';

try {
  const response = await rabbitmqOverviewRetrieve({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

200 -

Field Type Description
cluster_name string Name of the RabbitMQ cluster
rabbitmq_version string RabbitMQ server version
erlang_version string Erlang/OTP runtime version
message_stats any Message throughput statistics with rates
queue_totals any Global queue message counts
object_totals any Counts of connections, channels, queues, etc.
node string Current RabbitMQ node name
listeners array of objects Active protocol listeners
listeners.protocol string Protocol name (e.g., 'amqp', 'http', 'clustering')
listeners.port integer Listening port number

503 -

Field Type Description
error string Error message describing what went wrong

Rabbitmq Stats

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/rabbitmq-stats/ Get RabbitMQ subscription queue statistics
Other Actions
POST /api/rabbitmq-stats/ Purge or delete RabbitMQ subscription queues

Core CRUD

Get RabbitMQ subscription queue statistics

Provides statistics about RabbitMQ subscription queues.

Returns information about all vhosts with their subscription queues, including: - Queue names and message counts - Waldur user and subscription information linked to each vhost - Total message counts per vhost and across all vhosts

Requires support user permissions.

1
2
3
4
http \
  GET \
  https://api.example.com/api/rabbitmq-stats/ \
  Authorization:"Token YOUR_API_TOKEN"

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.rabbitmq_stats import rabbitmq_stats_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = rabbitmq_stats_retrieve.sync(client=client)

print(response)
  1. API Source: rabbitmq_stats_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { rabbitmqStatsRetrieve } from 'waldur-js-client';

try {
  const response = await rabbitmqStatsRetrieve({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

200 -

Field Type Description
vhosts array of objects List of vhosts with their subscription queues
vhosts.name string Virtual host name (corresponds to Waldur user UUID)
vhosts.user any Waldur user associated with this vhost
vhosts.queues array of objects List of subscription queues in this vhost
vhosts.queues.name string Queue name (e.g., 'subscription_{uuid}offering')}_{type
vhosts.queues.messages integer Total number of messages in the queue
vhosts.queues.messages_ready integer Number of messages ready for delivery
vhosts.queues.messages_unacknowledged integer Number of messages awaiting acknowledgement
vhosts.queues.consumers integer Number of active consumers for this queue
vhosts.queues.subscription_uuid string Parsed subscription UUID from queue name
vhosts.queues.offering_uuid string Parsed offering UUID from queue name
vhosts.queues.object_type string Parsed object type from queue name (e.g., 'resource', 'order')
vhosts.queues.message_ttl integer Message TTL in milliseconds
vhosts.queues.max_length integer Maximum number of messages in queue
vhosts.queues.max_length_bytes integer Maximum total size of messages in bytes
vhosts.queues.expires integer Queue TTL - auto-delete after idle in milliseconds
vhosts.queues.overflow string Behavior when full: 'drop-head', 'reject-publish', or 'reject-publish-dlx'
vhosts.queues.dead_letter_exchange string Dead letter exchange name
vhosts.queues.dead_letter_routing_key string Dead letter routing key
vhosts.queues.max_priority integer Maximum priority level (1-255)
vhosts.queues.queue_mode string Queue mode: 'default' or 'lazy'
vhosts.queues.queue_type string Queue type: 'classic', 'quorum', or 'stream'
vhosts.total_messages integer Total messages across all queues in this vhost
total_messages integer Total messages across all subscription queues
total_queues integer Total number of subscription queues

503 -

Field Type Description
error string Error message describing what went wrong

Other Actions

Purge or delete RabbitMQ subscription queues

Purges messages from or deletes specified RabbitMQ subscription queues.

Purge operations (remove messages, keep queue): - vhost and queue_name: Purge a specific queue - vhost and queue_pattern: Purge queues matching pattern (e.g., '*_resource') - purge_all_subscription_queues: Purge all subscription queues across all vhosts

Delete operations (remove queue entirely): - vhost, queue_name, and delete_queue=true: Delete a specific queue - vhost, queue_pattern, and delete_queue=true: Delete queues matching pattern - delete_all_subscription_queues: Delete all subscription queues across all vhosts

Requires staff permissions (more restrictive than viewing).

1
2
3
4
http \
  POST \
  https://api.example.com/api/rabbitmq-stats/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.rmq_purge_request_request import RmqPurgeRequestRequest # (1)
from waldur_api_client.api.rabbitmq_stats import rabbitmq_stats # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = RmqPurgeRequestRequest()
response = rabbitmq_stats.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: RmqPurgeRequestRequest
  2. API Source: rabbitmq_stats
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { rabbitmqStats } from 'waldur-js-client';

try {
  const response = await rabbitmqStats({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
vhost string Virtual host name containing the queue(s)
queue_name string Specific queue name (requires vhost)
queue_pattern string Glob pattern to match queue names (e.g., '*_resource'). Requires vhost.
purge_all_subscription_queues boolean If true, purge all subscription queues across all vhosts
Constraints: default: False
delete_queue boolean If true, delete the queue(s) entirely instead of just purging messages
Constraints: default: False
delete_all_subscription_queues boolean If true, delete all subscription queues across all vhosts
Constraints: default: False

200 -

Field Type Description
purged_queues integer Number of queues that were purged
purged_messages integer Total number of messages that were purged
deleted_queues integer Number of queues that were deleted

400 -

Field Type Description
error string Error message describing what went wrong

404 -

Field Type Description
error string Error message describing what went wrong

503 -

Field Type Description
error string Error message describing what went wrong

Rabbitmq User Stats

Operations Summary

Method Endpoint Description
GET /api/rabbitmq-user-stats/ Get RabbitMQ user connection statistics

Get RabbitMQ user connection statistics

Returns enriched connection data for all RabbitMQ users.

For each user (which corresponds to an EventSubscription), provides: - Connection state (running, blocked, blocking) - Traffic statistics (bytes sent/received) - Connection timestamp - Client properties (product, version, platform) - Channel count and heartbeat timeout

Requires support user permissions.

1
2
3
4
http \
  GET \
  https://api.example.com/api/rabbitmq-user-stats/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.rabbitmq_user_stats import rabbitmq_user_stats_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = rabbitmq_user_stats_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: rabbitmq_user_stats_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { rabbitmqUserStatsList } from 'waldur-js-client';

try {
  const response = await rabbitmqUserStatsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
username string RabbitMQ username (corresponds to EventSubscription UUID)
connections array of objects List of active connections with detailed statistics
connections.source_ip string Client IP address
connections.vhost string Virtual host name
connections.connected_at string (date-time) Connection establishment timestamp
connections.state string Connection state: 'running', 'blocked', 'blocking'
connections.recv_oct integer Bytes received on this connection
connections.send_oct integer Bytes sent on this connection
connections.channels integer Number of channels on this connection
connections.timeout integer Heartbeat timeout in seconds
connections.client_properties any Client identification properties

Rabbitmq Vhost Stats

Operations Summary

Method Endpoint Description
GET /api/rabbitmq-vhost-stats/ List Rabbitmq Vhost Stats

List Rabbitmq Vhost Stats

1
2
3
4
http \
  GET \
  https://api.example.com/api/rabbitmq-vhost-stats/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.rabbitmq_vhost_stats import rabbitmq_vhost_stats_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = rabbitmq_vhost_stats_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: rabbitmq_vhost_stats_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { rabbitmqVhostStatsList } from 'waldur-js-client';

try {
  const response = await rabbitmqVhostStatsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
name string
waldur_user any
subscriptions array of objects
subscriptions.created string (date-time)
subscriptions.uuid string (uuid)
subscriptions.source_ip any An IPv4 or IPv6 address.

Structure

Customers

A Customer (often referred to as an "Organization") is the top-level entity in the platform that represents a legal body or an independent division. It serves as the primary container for billing, user management, and resource ownership.

All projects, resources, and costs are ultimately tied to a Customer. Users are granted permissions within the scope of a Customer or one of its child Projects.

Key Concepts

  • Billing Root: Invoices are generated at the Customer level, aggregating costs from all its projects.
  • Ownership: A Customer is owned by one or more users who have full administrative control over its properties, team, and projects.
  • Team Management: Users can be added as team members to a Customer with specific roles (e.g., Owner, Manager), granting them permissions across the entire organization.

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/customers/ List customers
GET /api/customers/{uuid}/ Retrieve customer details
POST /api/customers/ Create a new customer
PUT /api/customers/{uuid}/ Update a customer
PUT /api/customers/{uuid}/update-project-digest-config/ Update project digest configuration
PATCH /api/customers/{uuid}/ Partially update a customer
PATCH /api/customers/{uuid}/update-project-digest-config/ Update project digest configuration
DELETE /api/customers/{uuid}/ Delete a customer
User Management
GET /api/customers/{uuid}/list_users/ List users and their roles in a scope
GET /api/customers/{customer_uuid}/users/ List users of a customer
POST /api/customers/{uuid}/add_user/ Grant a role to a user
POST /api/customers/{uuid}/delete_user/ Revoke a role from a user
POST /api/customers/{uuid}/update_user/ Update a user's role expiration
Compliance
GET /api/customers/{customer_uuid}/project-metadata-compliance-details/ Get detailed project metadata compliance
GET /api/customers/{customer_uuid}/project-metadata-compliance-overview/ Get project metadata compliance overview
GET /api/customers/{customer_uuid}/project-metadata-compliance-projects/ List projects with compliance data
GET /api/customers/{customer_uuid}/project-metadata-question-answers/ List questions with project answers
Configuration & Updates
POST /api/customers/{uuid}/update_organization_groups/ Update organization groups for a customer
Data & Reporting
GET /api/customers/countries/ Get list of available countries
GET /api/customers/{uuid}/stats/ Get customer resource usage statistics
Other Actions
GET /api/customers/{uuid}/history/at/ Get object state at a specific timestamp
GET /api/customers/{uuid}/history/ Get version history
GET /api/customers/{uuid}/project-digest-config/ Get project digest configuration
POST /api/customers/{uuid}/contact/ Update customer contact details
POST /api/customers/{uuid}/project-digest-config/preview/ Preview digest for a project
POST /api/customers/{uuid}/project-digest-config/send-test/ Send a test digest email

Core CRUD

List customers

Retrieve a list of customers. The list is filtered based on the user's permissions.

1
2
3
4
http \
  GET \
  https://api.example.com/api/customers/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.customer_field_enum import CustomerFieldEnum # (1)
from waldur_api_client.api.customers import customers_list # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = customers_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: CustomerFieldEnum
  2. API Source: customers_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { customersList } from 'waldur-js-client';

try {
  const response = await customersList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
abbreviation string Abbreviation
accounting_is_running boolean Filter by whether accounting is running.
agreement_number string
archived boolean
backend_id string
contact_details string Contact details
current_user_has_project_create_permission boolean Return a list of customers where current user has project create permission.
field array
has_resources string Filter by customers with resources.
is_call_managing_organization boolean Filter by customers that are call managing organizations.
is_service_provider boolean Filter by customers that are service providers.
name string Name
name_exact string Name (exact)
native_name string Native name
o string Which field to use when ordering the results.
organization_group_name string Organization group name
organization_group_uuid array Organization group UUID
owned_by_current_user boolean Return a list of customers where current user is owner.
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
query string Filter by name, native name, abbreviation, domain, UUID, registration code or agreement number
registration_code string
service_provider_uuid string (uuid) Filter by service provider UUID.
user_uuid string (uuid) Filter by user UUID.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
created string (date-time)
organization_groups array of objects Organization groups this customer belongs to
organization_groups.uuid string (uuid)
organization_groups.url string (uri)
organization_groups.name string
organization_groups.parent_uuid string (uuid) UUID of the parent organization group
organization_groups.parent_name string Name of the parent organization group
organization_groups.parent string (uri)
organization_groups.customers_count integer Number of customers in this organization group
display_name string Display name of the organization (includes native name if available)
backend_id string Organization identifier in another application.
image string (uri)
blocked boolean
archived boolean
display_billing_info_in_projects boolean
default_tax_percent string (decimal)
accounting_start_date string (date-time)
projects_count integer Number of projects in this organization
users_count integer Number of users with access to this organization
sponsor_number integer External ID of the sponsor covering the costs
country_name string Human-readable country name
max_service_accounts integer Maximum number of service accounts allowed
project_metadata_checklist string (uuid) Checklist to be used for project metadata validation in this organization
grace_period_days integer Number of extra days after project end date before resources are terminated
user_email_patterns any
user_affiliations any
user_identity_sources any List of allowed identity sources (identity providers).
name string
slug string URL-friendly identifier. Only editable by staff users.
native_name string
abbreviation string
description string
contact_details string
agreement_number string
email string (email)
phone_number string
access_subnets string Enter a comma separated list of IPv4 or IPv6 CIDR addresses from where connection to self-service is allowed.
registration_code string
homepage string (uri)
domain string
vat_code string VAT number
postal string
address string
bank_name string
latitude number (double)
longitude number (double)
bank_account string
country any Country code (ISO 3166-1 alpha-2)
notification_emails string Comma-separated list of notification email addresses
payment_profiles array of objects
payment_profiles.uuid string (uuid)
payment_profiles.url string (uri)
payment_profiles.name string
payment_profiles.organization_uuid string (uuid)
payment_profiles.organization string (uri)
payment_profiles.attributes object
payment_profiles.attributes.end_date string
payment_profiles.attributes.agreement_number string
payment_profiles.attributes.contract_sum integer
payment_profiles.payment_type string
Enum: fixed_price, invoices, payment_gw_monthly
payment_profiles.payment_type_display string
payment_profiles.is_active boolean
customer_credit number (double)
customer_unallocated_credit number (double)
is_service_provider boolean
service_provider string (uri)
service_provider_uuid string (uuid)
call_managing_organization_uuid string
billing_price_estimate any

Retrieve customer details

Fetch the details of a specific customer by its UUID.

1
2
3
4
http \
  GET \
  https://api.example.com/api/customers/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.customer_field_enum import CustomerFieldEnum # (1)
from waldur_api_client.api.customers import customers_retrieve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = customers_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. Model Source: CustomerFieldEnum
  2. API Source: customers_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { customersRetrieve } from 'waldur-js-client';

try {
  const response = await customersRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type
field array

200 -

Field Type Description
url string (uri)
uuid string (uuid)
created string (date-time)
organization_groups array of objects Organization groups this customer belongs to
organization_groups.uuid string (uuid)
organization_groups.url string (uri)
organization_groups.name string
organization_groups.parent_uuid string (uuid) UUID of the parent organization group
organization_groups.parent_name string Name of the parent organization group
organization_groups.parent string (uri)
organization_groups.customers_count integer Number of customers in this organization group
display_name string Display name of the organization (includes native name if available)
backend_id string Organization identifier in another application.
image string (uri)
blocked boolean
archived boolean
display_billing_info_in_projects boolean
default_tax_percent string (decimal)
accounting_start_date string (date-time)
projects_count integer Number of projects in this organization
users_count integer Number of users with access to this organization
sponsor_number integer External ID of the sponsor covering the costs
country_name string Human-readable country name
max_service_accounts integer Maximum number of service accounts allowed
project_metadata_checklist string (uuid) Checklist to be used for project metadata validation in this organization
grace_period_days integer Number of extra days after project end date before resources are terminated
user_email_patterns any
user_affiliations any
user_identity_sources any List of allowed identity sources (identity providers).
name string
slug string URL-friendly identifier. Only editable by staff users.
native_name string
abbreviation string
description string
contact_details string
agreement_number string
email string (email)
phone_number string
access_subnets string Enter a comma separated list of IPv4 or IPv6 CIDR addresses from where connection to self-service is allowed.
registration_code string
homepage string (uri)
domain string
vat_code string VAT number
postal string
address string
bank_name string
latitude number (double)
longitude number (double)
bank_account string
country any Country code (ISO 3166-1 alpha-2)
notification_emails string Comma-separated list of notification email addresses
payment_profiles array of objects
payment_profiles.uuid string (uuid)
payment_profiles.url string (uri)
payment_profiles.name string
payment_profiles.organization_uuid string (uuid)
payment_profiles.organization string (uri)
payment_profiles.attributes object
payment_profiles.attributes.end_date string
payment_profiles.attributes.agreement_number string
payment_profiles.attributes.contract_sum integer
payment_profiles.payment_type string
Enum: fixed_price, invoices, payment_gw_monthly
payment_profiles.payment_type_display string
payment_profiles.is_active boolean
customer_credit number (double)
customer_unallocated_credit number (double)
is_service_provider boolean
service_provider string (uri)
service_provider_uuid string (uuid)
call_managing_organization_uuid string
billing_price_estimate any

Create a new customer

A new customer can only be created by users with staff privilege.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/customers/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-customer"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.customer_request import CustomerRequest # (1)
from waldur_api_client.api.customers import customers_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = CustomerRequest(
    name="my-awesome-customer"
)
response = customers_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: CustomerRequest
  2. API Source: customers_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { customersCreate } from 'waldur-js-client';

try {
  const response = await customersCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "name": "my-awesome-customer"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
backend_id string Organization identifier in another application.
image string (binary)
blocked boolean
archived boolean
display_billing_info_in_projects boolean
default_tax_percent string (decimal)
accounting_start_date string (date-time)
sponsor_number integer External ID of the sponsor covering the costs
max_service_accounts integer Maximum number of service accounts allowed
project_metadata_checklist string (uuid) Checklist to be used for project metadata validation in this organization
grace_period_days integer Number of extra days after project end date before resources are terminated
user_email_patterns any
user_affiliations any
user_identity_sources any List of allowed identity sources (identity providers).
name string ✓
slug string URL-friendly identifier. Only editable by staff users.
native_name string
abbreviation string
description string
contact_details string
agreement_number string
email string (email)
phone_number string
access_subnets string Enter a comma separated list of IPv4 or IPv6 CIDR addresses from where connection to self-service is allowed.
registration_code string
homepage string (uri)
domain string
vat_code string VAT number
postal string
address string
bank_name string
latitude number (double)
longitude number (double)
bank_account string
country any Country code (ISO 3166-1 alpha-2)
notification_emails string Comma-separated list of notification email addresses

201 -

Field Type Description
url string (uri)
uuid string (uuid)
created string (date-time)
organization_groups array of objects Organization groups this customer belongs to
organization_groups.uuid string (uuid)
organization_groups.url string (uri)
organization_groups.name string
organization_groups.parent_uuid string (uuid) UUID of the parent organization group
organization_groups.parent_name string Name of the parent organization group
organization_groups.parent string (uri)
organization_groups.customers_count integer Number of customers in this organization group
display_name string Display name of the organization (includes native name if available)
backend_id string Organization identifier in another application.
image string (uri)
blocked boolean
archived boolean
display_billing_info_in_projects boolean
default_tax_percent string (decimal)
accounting_start_date string (date-time)
projects_count integer Number of projects in this organization
users_count integer Number of users with access to this organization
sponsor_number integer External ID of the sponsor covering the costs
country_name string Human-readable country name
max_service_accounts integer Maximum number of service accounts allowed
project_metadata_checklist string (uuid) Checklist to be used for project metadata validation in this organization
grace_period_days integer Number of extra days after project end date before resources are terminated
user_email_patterns any
user_affiliations any
user_identity_sources any List of allowed identity sources (identity providers).
name string
slug string URL-friendly identifier. Only editable by staff users.
native_name string
abbreviation string
description string
contact_details string
agreement_number string
email string (email)
phone_number string
access_subnets string Enter a comma separated list of IPv4 or IPv6 CIDR addresses from where connection to self-service is allowed.
registration_code string
homepage string (uri)
domain string
vat_code string VAT number
postal string
address string
bank_name string
latitude number (double)
longitude number (double)
bank_account string
country any Country code (ISO 3166-1 alpha-2)
notification_emails string Comma-separated list of notification email addresses
payment_profiles array of objects
payment_profiles.uuid string (uuid)
payment_profiles.url string (uri)
payment_profiles.name string
payment_profiles.organization_uuid string (uuid)
payment_profiles.organization string (uri)
payment_profiles.attributes object
payment_profiles.attributes.end_date string
payment_profiles.attributes.agreement_number string
payment_profiles.attributes.contract_sum integer
payment_profiles.payment_type string
Enum: fixed_price, invoices, payment_gw_monthly
payment_profiles.payment_type_display string
payment_profiles.is_active boolean
customer_credit number (double)
customer_unallocated_credit number (double)
is_service_provider boolean
service_provider string (uri)
service_provider_uuid string (uuid)
call_managing_organization_uuid string
billing_price_estimate any

Update a customer

Update the details of an existing customer. Requires customer owner or staff permissions.

1
2
3
4
5
http \
  PUT \
  https://api.example.com/api/customers/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-customer"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.customer_request import CustomerRequest # (1)
from waldur_api_client.api.customers import customers_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = CustomerRequest(
    name="my-awesome-customer"
)
response = customers_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: CustomerRequest
  2. API Source: customers_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { customersUpdate } from 'waldur-js-client';

try {
  const response = await customersUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-customer"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
backend_id string Organization identifier in another application.
image string (binary)
blocked boolean
archived boolean
display_billing_info_in_projects boolean
default_tax_percent string (decimal)
accounting_start_date string (date-time)
sponsor_number integer External ID of the sponsor covering the costs
max_service_accounts integer Maximum number of service accounts allowed
project_metadata_checklist string (uuid) Checklist to be used for project metadata validation in this organization
grace_period_days integer Number of extra days after project end date before resources are terminated
user_email_patterns any
user_affiliations any
user_identity_sources any List of allowed identity sources (identity providers).
name string ✓
slug string URL-friendly identifier. Only editable by staff users.
native_name string
abbreviation string
description string
contact_details string
agreement_number string
email string (email)
phone_number string
access_subnets string Enter a comma separated list of IPv4 or IPv6 CIDR addresses from where connection to self-service is allowed.
registration_code string
homepage string (uri)
domain string
vat_code string VAT number
postal string
address string
bank_name string
latitude number (double)
longitude number (double)
bank_account string
country any Country code (ISO 3166-1 alpha-2)
notification_emails string Comma-separated list of notification email addresses

200 -

Field Type Description
url string (uri)
uuid string (uuid)
created string (date-time)
organization_groups array of objects Organization groups this customer belongs to
organization_groups.uuid string (uuid)
organization_groups.url string (uri)
organization_groups.name string
organization_groups.parent_uuid string (uuid) UUID of the parent organization group
organization_groups.parent_name string Name of the parent organization group
organization_groups.parent string (uri)
organization_groups.customers_count integer Number of customers in this organization group
display_name string Display name of the organization (includes native name if available)
backend_id string Organization identifier in another application.
image string (uri)
blocked boolean
archived boolean
display_billing_info_in_projects boolean
default_tax_percent string (decimal)
accounting_start_date string (date-time)
projects_count integer Number of projects in this organization
users_count integer Number of users with access to this organization
sponsor_number integer External ID of the sponsor covering the costs
country_name string Human-readable country name
max_service_accounts integer Maximum number of service accounts allowed
project_metadata_checklist string (uuid) Checklist to be used for project metadata validation in this organization
grace_period_days integer Number of extra days after project end date before resources are terminated
user_email_patterns any
user_affiliations any
user_identity_sources any List of allowed identity sources (identity providers).
name string
slug string URL-friendly identifier. Only editable by staff users.
native_name string
abbreviation string
description string
contact_details string
agreement_number string
email string (email)
phone_number string
access_subnets string Enter a comma separated list of IPv4 or IPv6 CIDR addresses from where connection to self-service is allowed.
registration_code string
homepage string (uri)
domain string
vat_code string VAT number
postal string
address string
bank_name string
latitude number (double)
longitude number (double)
bank_account string
country any Country code (ISO 3166-1 alpha-2)
notification_emails string Comma-separated list of notification email addresses
payment_profiles array of objects
payment_profiles.uuid string (uuid)
payment_profiles.url string (uri)
payment_profiles.name string
payment_profiles.organization_uuid string (uuid)
payment_profiles.organization string (uri)
payment_profiles.attributes object
payment_profiles.attributes.end_date string
payment_profiles.attributes.agreement_number string
payment_profiles.attributes.contract_sum integer
payment_profiles.payment_type string
Enum: fixed_price, invoices, payment_gw_monthly
payment_profiles.payment_type_display string
payment_profiles.is_active boolean
customer_credit number (double)
customer_unallocated_credit number (double)
is_service_provider boolean
service_provider string (uri)
service_provider_uuid string (uuid)
call_managing_organization_uuid string
billing_price_estimate any

Update project digest configuration

Update the project digest email configuration for this organization.

1
2
3
4
http \
  PUT \
  https://api.example.com/api/customers/a1b2c3d4-e5f6-7890-abcd-ef1234567890/update-project-digest-config/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.project_digest_config_request import ProjectDigestConfigRequest # (1)
from waldur_api_client.api.customers import customers_update_project_digest_config_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ProjectDigestConfigRequest()
response = customers_update_project_digest_config_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ProjectDigestConfigRequest
  2. API Source: customers_update_project_digest_config_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { customersUpdateProjectDigestConfigUpdate } from 'waldur-js-client';

try {
  const response = await customersUpdateProjectDigestConfigUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
is_enabled boolean
frequency string
Enum: weekly, biweekly, monthly
enabled_sections array of strings
day_of_week integer For weekly/biweekly: 0=Sunday..6=Saturday
day_of_month integer For monthly: day of month (1-28)

200 -

Field Type Description
uuid string (uuid)
is_enabled boolean
frequency string
Enum: weekly, biweekly, monthly
enabled_sections array of strings
day_of_week integer For weekly/biweekly: 0=Sunday..6=Saturday
day_of_month integer For monthly: day of month (1-28)
last_sent_at string (date-time)
available_sections array of objects

Partially update a customer

Partially update the details of an existing customer. Requires customer owner or staff permissions.

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/customers/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_customer_request import PatchedCustomerRequest # (1)
from waldur_api_client.api.customers import customers_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedCustomerRequest()
response = customers_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedCustomerRequest
  2. API Source: customers_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { customersPartialUpdate } from 'waldur-js-client';

try {
  const response = await customersPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
backend_id string Organization identifier in another application.
image string (binary)
blocked boolean
archived boolean
display_billing_info_in_projects boolean
default_tax_percent string (decimal)
accounting_start_date string (date-time)
sponsor_number integer External ID of the sponsor covering the costs
max_service_accounts integer Maximum number of service accounts allowed
project_metadata_checklist string (uuid) Checklist to be used for project metadata validation in this organization
grace_period_days integer Number of extra days after project end date before resources are terminated
user_email_patterns any
user_affiliations any
user_identity_sources any List of allowed identity sources (identity providers).
name string
slug string URL-friendly identifier. Only editable by staff users.
native_name string
abbreviation string
description string
contact_details string
agreement_number string
email string (email)
phone_number string
access_subnets string Enter a comma separated list of IPv4 or IPv6 CIDR addresses from where connection to self-service is allowed.
registration_code string
homepage string (uri)
domain string
vat_code string VAT number
postal string
address string
bank_name string
latitude number (double)
longitude number (double)
bank_account string
country any Country code (ISO 3166-1 alpha-2)
notification_emails string Comma-separated list of notification email addresses

200 -

Field Type Description
url string (uri)
uuid string (uuid)
created string (date-time)
organization_groups array of objects Organization groups this customer belongs to
organization_groups.uuid string (uuid)
organization_groups.url string (uri)
organization_groups.name string
organization_groups.parent_uuid string (uuid) UUID of the parent organization group
organization_groups.parent_name string Name of the parent organization group
organization_groups.parent string (uri)
organization_groups.customers_count integer Number of customers in this organization group
display_name string Display name of the organization (includes native name if available)
backend_id string Organization identifier in another application.
image string (uri)
blocked boolean
archived boolean
display_billing_info_in_projects boolean
default_tax_percent string (decimal)
accounting_start_date string (date-time)
projects_count integer Number of projects in this organization
users_count integer Number of users with access to this organization
sponsor_number integer External ID of the sponsor covering the costs
country_name string Human-readable country name
max_service_accounts integer Maximum number of service accounts allowed
project_metadata_checklist string (uuid) Checklist to be used for project metadata validation in this organization
grace_period_days integer Number of extra days after project end date before resources are terminated
user_email_patterns any
user_affiliations any
user_identity_sources any List of allowed identity sources (identity providers).
name string
slug string URL-friendly identifier. Only editable by staff users.
native_name string
abbreviation string
description string
contact_details string
agreement_number string
email string (email)
phone_number string
access_subnets string Enter a comma separated list of IPv4 or IPv6 CIDR addresses from where connection to self-service is allowed.
registration_code string
homepage string (uri)
domain string
vat_code string VAT number
postal string
address string
bank_name string
latitude number (double)
longitude number (double)
bank_account string
country any Country code (ISO 3166-1 alpha-2)
notification_emails string Comma-separated list of notification email addresses
payment_profiles array of objects
payment_profiles.uuid string (uuid)
payment_profiles.url string (uri)
payment_profiles.name string
payment_profiles.organization_uuid string (uuid)
payment_profiles.organization string (uri)
payment_profiles.attributes object
payment_profiles.attributes.end_date string
payment_profiles.attributes.agreement_number string
payment_profiles.attributes.contract_sum integer
payment_profiles.payment_type string
Enum: fixed_price, invoices, payment_gw_monthly
payment_profiles.payment_type_display string
payment_profiles.is_active boolean
customer_credit number (double)
customer_unallocated_credit number (double)
is_service_provider boolean
service_provider string (uri)
service_provider_uuid string (uuid)
call_managing_organization_uuid string
billing_price_estimate any

Update project digest configuration

Update the project digest email configuration for this organization.

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/customers/a1b2c3d4-e5f6-7890-abcd-ef1234567890/update-project-digest-config/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_project_digest_config_request import PatchedProjectDigestConfigRequest # (1)
from waldur_api_client.api.customers import customers_update_project_digest_config_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedProjectDigestConfigRequest()
response = customers_update_project_digest_config_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedProjectDigestConfigRequest
  2. API Source: customers_update_project_digest_config_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { customersUpdateProjectDigestConfigPartialUpdate } from 'waldur-js-client';

try {
  const response = await customersUpdateProjectDigestConfigPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
is_enabled boolean
frequency string
Enum: weekly, biweekly, monthly
enabled_sections array of strings
day_of_week integer For weekly/biweekly: 0=Sunday..6=Saturday
day_of_month integer For monthly: day of month (1-28)

200 -

Field Type Description
uuid string (uuid)
is_enabled boolean
frequency string
Enum: weekly, biweekly, monthly
enabled_sections array of strings
day_of_week integer For weekly/biweekly: 0=Sunday..6=Saturday
day_of_month integer For monthly: day of month (1-28)
last_sent_at string (date-time)
available_sections array of objects

Delete a customer

Delete a customer. This action is only available to staff users. If a customer has any active projects, the deletion request will fail with a 409 Conflict response.

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/customers/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.customers import customers_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = customers_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: customers_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { customersDestroy } from 'waldur-js-client';

try {
  const response = await customersDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

User Management

List users and their roles in a scope

Retrieves a list of users who have a role within a specific scope (e.g., a project or an organization). The list can be filtered by user details or role.

1
2
3
4
http \
  GET \
  https://api.example.com/api/customers/a1b2c3d4-e5f6-7890-abcd-ef1234567890/list_users/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.user_role_details_field_enum import UserRoleDetailsFieldEnum # (1)
from waldur_api_client.models.user_role_details_o_enum import UserRoleDetailsOEnum # (2)
from waldur_api_client.api.customers import customers_list_users_list # (3)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = customers_list_users_list.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

for item in response:
    print(item)
  1. Model Source: UserRoleDetailsFieldEnum
  2. Model Source: UserRoleDetailsOEnum
  3. API Source: customers_list_users_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { customersListUsersList } from 'waldur-js-client';

try {
  const response = await customersListUsersList({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type Description
field array Fields to include in response
full_name string User full name
native_name string User native name
o array Ordering fields
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
role string (uuid) Role UUID or name
search_string string Search string for user
user string (uuid) User UUID
user_slug string User slug
user_url string User URL
username string User username

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid)
created string (date-time)
expiration_time string (date-time)
role_name string
role_uuid string (uuid)
user_email string (email)
user_full_name string
user_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
user_uuid string (uuid)
user_image string (uri)
created_by_full_name string
created_by_uuid string (uuid)

List users of a customer

Lists all users who have a role in the specified customer or any of its projects. Requires permissions to list customer users.

1
2
3
4
http \
  GET \
  https://api.example.com/api/customers/a1b2c3d4-e5f6-7890-abcd-ef1234567890/users/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.customer_user_field_enum import CustomerUserFieldEnum # (1)
from waldur_api_client.models.customer_user_o_enum import CustomerUserOEnum # (2)
from waldur_api_client.api.customers import customers_users_list # (3)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = customers_users_list.sync(
    customer_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

for item in response:
    print(item)
  1. Model Source: CustomerUserFieldEnum
  2. Model Source: CustomerUserOEnum
  3. API Source: customers_users_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { customersUsersList } from 'waldur-js-client';

try {
  const response = await customersUsersList({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "customer_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
customer_uuid string (uuid) ✓ UUID of the customer
Name Type Description
agreement_date string (date-time) Agreement date after
civil_number string
date_joined string (date-time) Date joined after
description string
email string Email
field array
full_name string Full name
is_active boolean Is active
job_title string Job title
modified string (date-time) Date modified after
native_name string Native name
o string Ordering. Sort by a combination of first name, last name, and username.
Enum: concatenated_name, -concatenated_name
organization string Organization
organization_role array Filter by one or more organization roles. Select a standard role or provide a custom role string. Can be specified multiple times.
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
phone_number string
project_role array Filter by one or more project roles. Select a standard role or provide a custom role string. Can be specified multiple times.
registration_method string
user_keyword string User keyword
username string Username

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
full_name string
email string (email)
role_name string
projects array of objects
projects.url string (uri)
projects.uuid string
projects.name string
projects.role_name string
projects.expiration_time string (date-time)
expiration_time string (date-time)
image string (uri)

Grant a role to a user

Assigns a specific role to a user within the current scope. An optional expiration time for the role can be set.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/customers/a1b2c3d4-e5f6-7890-abcd-ef1234567890/add_user/ \
  Authorization:"Token YOUR_API_TOKEN" \
  role="string-value" \
  user="a1b2c3d4-e5f6-7890-abcd-ef1234567890"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.user_role_create_request import UserRoleCreateRequest # (1)
from waldur_api_client.api.customers import customers_add_user # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = UserRoleCreateRequest(
    role="string-value",
    user="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
)
response = customers_add_user.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: UserRoleCreateRequest
  2. API Source: customers_add_user
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { customersAddUser } from 'waldur-js-client';

try {
  const response = await customersAddUser({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "role": "string-value",
    "user": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
role string ✓
user string (uuid) ✓
expiration_time string (date-time)

201 -

Field Type
expiration_time string (date-time)

400 - Validation error, for example when trying to add a user to a terminated project.

Revoke a role from a user

Removes a specific role from a user within the current scope. This effectively revokes their permissions associated with that role.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/customers/a1b2c3d4-e5f6-7890-abcd-ef1234567890/delete_user/ \
  Authorization:"Token YOUR_API_TOKEN" \
  role="string-value" \
  user="a1b2c3d4-e5f6-7890-abcd-ef1234567890"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.user_role_delete_request import UserRoleDeleteRequest # (1)
from waldur_api_client.api.customers import customers_delete_user # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = UserRoleDeleteRequest(
    role="string-value",
    user="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
)
response = customers_delete_user.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: UserRoleDeleteRequest
  2. API Source: customers_delete_user
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { customersDeleteUser } from 'waldur-js-client';

try {
  const response = await customersDeleteUser({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "role": "string-value",
    "user": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
role string ✓
user string (uuid) ✓
expiration_time string (date-time)

200 - Role revoked successfully.

Update a user's role expiration

Updates the expiration time for a user's existing role in the current scope. This is useful for extending or shortening the duration of a permission. To make a role permanent, set expiration_time to null.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/customers/a1b2c3d4-e5f6-7890-abcd-ef1234567890/update_user/ \
  Authorization:"Token YOUR_API_TOKEN" \
  role="string-value" \
  user="a1b2c3d4-e5f6-7890-abcd-ef1234567890"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.user_role_update_request import UserRoleUpdateRequest # (1)
from waldur_api_client.api.customers import customers_update_user # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = UserRoleUpdateRequest(
    role="string-value",
    user="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
)
response = customers_update_user.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: UserRoleUpdateRequest
  2. API Source: customers_update_user
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { customersUpdateUser } from 'waldur-js-client';

try {
  const response = await customersUpdateUser({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "role": "string-value",
    "user": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
role string ✓
user string (uuid) ✓
expiration_time string (date-time)

200 -

Field Type
expiration_time string (date-time)

Compliance

Get detailed project metadata compliance

Provides detailed compliance status for all projects within a customer, including individual answers and completion status.

1
2
3
4
http \
  GET \
  https://api.example.com/api/customers/a1b2c3d4-e5f6-7890-abcd-ef1234567890/project-metadata-compliance-details/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.customers import customers_project_metadata_compliance_details_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = customers_project_metadata_compliance_details_list.sync(
    customer_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

for item in response:
    print(item)
  1. API Source: customers_project_metadata_compliance_details_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { customersProjectMetadataComplianceDetailsList } from 'waldur-js-client';

try {
  const response = await customersProjectMetadataComplianceDetailsList({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "customer_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
customer_uuid string (uuid) ✓ UUID of the customer
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
checklist any
total_projects integer
projects_with_completions integer
fully_completed_projects integer
projects_requiring_review integer
project_details array of objects
project_details.project_uuid string (uuid)
project_details.project_name string
project_details.completion_uuid string (uuid)
project_details.completion_percentage number (double)
project_details.is_completed boolean
project_details.requires_review boolean
project_details.answers array of anys
project_details.unanswered_required_questions array of anys

Get project metadata compliance overview

Provides aggregated statistics about project metadata compliance for all projects within a customer.

1
2
3
4
http \
  GET \
  https://api.example.com/api/customers/a1b2c3d4-e5f6-7890-abcd-ef1234567890/project-metadata-compliance-overview/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.customers import customers_project_metadata_compliance_overview_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = customers_project_metadata_compliance_overview_list.sync(
    customer_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

for item in response:
    print(item)
  1. API Source: customers_project_metadata_compliance_overview_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { customersProjectMetadataComplianceOverviewList } from 'waldur-js-client';

try {
  const response = await customersProjectMetadataComplianceOverviewList({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "customer_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
customer_uuid string (uuid) ✓ UUID of the customer
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
total_projects integer
projects_with_completions integer
fully_completed_projects integer
projects_requiring_review integer
average_completion_percentage number (double)

List projects with compliance data

Provides a paginated list of projects with their checklist completion status and answer details.

1
2
3
4
http \
  GET \
  https://api.example.com/api/customers/a1b2c3d4-e5f6-7890-abcd-ef1234567890/project-metadata-compliance-projects/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.customers import customers_project_metadata_compliance_projects_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = customers_project_metadata_compliance_projects_list.sync(
    customer_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

for item in response:
    print(item)
  1. API Source: customers_project_metadata_compliance_projects_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { customersProjectMetadataComplianceProjectsList } from 'waldur-js-client';

try {
  const response = await customersProjectMetadataComplianceProjectsList({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "customer_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
customer_uuid string (uuid) ✓ UUID of the customer
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
project_uuid string (uuid)
project_name string
completion_uuid string Get completion UUID.
completion_percentage number (double) Get completion percentage.
is_completed boolean Get completion status.
requires_review boolean Get review requirement status.
answers_count integer Get count of answers.
unanswered_required_count integer Get count of unanswered required questions.

List questions with project answers

Provides a paginated list of all questions from the customer's compliance checklist, including the answers given in each project.

1
2
3
4
http \
  GET \
  https://api.example.com/api/customers/a1b2c3d4-e5f6-7890-abcd-ef1234567890/project-metadata-question-answers/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.customers import customers_project_metadata_question_answers_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = customers_project_metadata_question_answers_list.sync(
    customer_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

for item in response:
    print(item)
  1. API Source: customers_project_metadata_question_answers_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { customersProjectMetadataQuestionAnswersList } from 'waldur-js-client';

try {
  const response = await customersProjectMetadataQuestionAnswersList({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "customer_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
customer_uuid string (uuid) ✓ UUID of the customer
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
question_uuid string (uuid)
question_description string
question_type string
required boolean
order integer
min_value string (decimal)
max_value string (decimal)
total_projects integer Get total projects count.
answered_projects_count integer Get count of projects that answered this question.
project_answers array of objects Get all project answers for this question.
question_options array of objects Get question options for select-type questions.

Configuration & Updates

Update organization groups for a customer

Assigns a customer to one or more organization groups. This action is restricted to staff users.

1
2
3
4
http \
  POST \
  https://api.example.com/api/customers/a1b2c3d4-e5f6-7890-abcd-ef1234567890/update_organization_groups/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.organization_groups_request import OrganizationGroupsRequest # (1)
from waldur_api_client.api.customers import customers_update_organization_groups # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OrganizationGroupsRequest()
response = customers_update_organization_groups.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OrganizationGroupsRequest
  2. API Source: customers_update_organization_groups
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { customersUpdateOrganizationGroups } from 'waldur-js-client';

try {
  const response = await customersUpdateOrganizationGroups({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
organization_groups array of string (uri)s

200 - No response body

Data & Reporting

Get list of available countries

Returns a list of countries that can be used when creating or updating a customer. The list can be configured by the service provider.

1
2
3
4
http \
  GET \
  https://api.example.com/api/customers/countries/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.customers import customers_countries_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = customers_countries_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: customers_countries_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { customersCountriesList } from 'waldur-js-client';

try {
  const response = await customersCountriesList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
abbreviation string Abbreviation
accounting_is_running boolean Filter by whether accounting is running.
agreement_number string
archived boolean
backend_id string
contact_details string Contact details
current_user_has_project_create_permission boolean Return a list of customers where current user has project create permission.
has_resources string Filter by customers with resources.
is_call_managing_organization boolean Filter by customers that are call managing organizations.
is_service_provider boolean Filter by customers that are service providers.
name string Name
name_exact string Name (exact)
native_name string Native name
o string Which field to use when ordering the results.
organization_group_name string Organization group name
organization_group_uuid array Organization group UUID
owned_by_current_user boolean Return a list of customers where current user is owner.
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
query string Filter by name, native name, abbreviation, domain, UUID, registration code or agreement number
registration_code string
service_provider_uuid string (uuid) Filter by service provider UUID.
user_uuid string (uuid) Filter by user UUID.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
label string
value string

Get customer resource usage statistics

Provides statistics about the resource usage (e.g., CPU, RAM, storage) for all projects within a customer. Can be filtered to show usage for the current month only.

1
2
3
4
http \
  GET \
  https://api.example.com/api/customers/a1b2c3d4-e5f6-7890-abcd-ef1234567890/stats/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.customers import customers_stats_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = customers_stats_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: customers_stats_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { customersStatsRetrieve } from 'waldur-js-client';

try {
  const response = await customersStatsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type Description
for_current_month boolean If true, returns usage data for the current month only. Otherwise, returns total usage.

200 -

Field Type
components array of objects
components.type string
components.name string
components.description string
components.measured_unit string
components.billing_type string
components.usage integer
components.limit_usage integer
components.limit integer
components.offering_name string
components.offering_uuid string (uuid)

Other Actions

Get object state at a specific timestamp

Returns the state of the object as it was at the specified timestamp. Only accessible by staff and support users.

1
2
3
4
5
http \
  GET \
  https://api.example.com/api/customers/a1b2c3d4-e5f6-7890-abcd-ef1234567890/history/at/ \
  Authorization:"Token YOUR_API_TOKEN" \
  timestamp=="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.customers import customers_history_at_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = customers_history_at_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    timestamp="string-value"
)

print(response)
  1. API Source: customers_history_at_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { customersHistoryAtRetrieve } from 'waldur-js-client';

try {
  const response = await customersHistoryAtRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  query: {
    "timestamp": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type Required Description
timestamp string ✓ ISO 8601 timestamp to query the object state at

200 -

Field Type Description
id integer Version ID
revision_date string (date-time) When this revision was created
revision_user object (free-form) User who created this revision
revision_comment string Comment describing the revision
serialized_data object (free-form) Serialized model fields at this revision

400 -

404 -

Get version history

Returns the version history for this object. Only accessible by staff and support users.

1
2
3
4
http \
  GET \
  https://api.example.com/api/customers/a1b2c3d4-e5f6-7890-abcd-ef1234567890/history/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.customers import customers_history_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = customers_history_list.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

for item in response:
    print(item)
  1. API Source: customers_history_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { customersHistoryList } from 'waldur-js-client';

try {
  const response = await customersHistoryList({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type Description
abbreviation string Abbreviation
accounting_is_running boolean Filter by whether accounting is running.
agreement_number string
archived boolean
backend_id string
contact_details string Contact details
created_after string Filter versions created after this timestamp (ISO 8601)
created_before string Filter versions created before this timestamp (ISO 8601)
current_user_has_project_create_permission boolean Return a list of customers where current user has project create permission.
has_resources string Filter by customers with resources.
is_call_managing_organization boolean Filter by customers that are call managing organizations.
is_service_provider boolean Filter by customers that are service providers.
name string Name
name_exact string Name (exact)
native_name string Native name
o string Which field to use when ordering the results.
organization_group_name string Organization group name
organization_group_uuid array Organization group UUID
owned_by_current_user boolean Return a list of customers where current user is owner.
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
query string Filter by name, native name, abbreviation, domain, UUID, registration code or agreement number
registration_code string
service_provider_uuid string (uuid) Filter by service provider UUID.
user_uuid string (uuid) Filter by user UUID.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
id integer Version ID
revision_date string (date-time) When this revision was created
revision_user object (free-form) User who created this revision
revision_comment string Comment describing the revision
serialized_data object (free-form) Serialized model fields at this revision

Get project digest configuration

Retrieve the project digest email configuration for this organization.

1
2
3
4
http \
  GET \
  https://api.example.com/api/customers/a1b2c3d4-e5f6-7890-abcd-ef1234567890/project-digest-config/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.customers import customers_project_digest_config_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = customers_project_digest_config_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: customers_project_digest_config_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { customersProjectDigestConfigRetrieve } from 'waldur-js-client';

try {
  const response = await customersProjectDigestConfigRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
uuid string (uuid)
is_enabled boolean
frequency string
Enum: weekly, biweekly, monthly
enabled_sections array of strings
day_of_week integer For weekly/biweekly: 0=Sunday..6=Saturday
day_of_month integer For monthly: day of month (1-28)
last_sent_at string (date-time)
available_sections array of objects

Update customer contact details

Update organization contact information. Requires CUSTOMER_CONTACT_UPDATE or CUSTOMER.UPDATE permission.

1
2
3
4
http \
  POST \
  https://api.example.com/api/customers/a1b2c3d4-e5f6-7890-abcd-ef1234567890/contact/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.customer_contact_update_request import CustomerContactUpdateRequest # (1)
from waldur_api_client.api.customers import customers_contact # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = CustomerContactUpdateRequest()
response = customers_contact.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: CustomerContactUpdateRequest
  2. API Source: customers_contact
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { customersContact } from 'waldur-js-client';

try {
  const response = await customersContact({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
contact_details string
email string (email)
phone_number string
homepage string (uri)
notification_emails string Comma-separated list of notification email addresses

200 -

Field Type Description
contact_details string
email string (email)
phone_number string
homepage string (uri)
notification_emails string Comma-separated list of notification email addresses

Preview digest for a project

Returns rendered HTML preview of the digest for a specific project.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/customers/a1b2c3d4-e5f6-7890-abcd-ef1234567890/project-digest-config/preview/ \
  Authorization:"Token YOUR_API_TOKEN" \
  project_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.project_digest_preview_request import ProjectDigestPreviewRequest # (1)
from waldur_api_client.api.customers import customers_project_digest_config_preview # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ProjectDigestPreviewRequest(
    project_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
)
response = customers_project_digest_config_preview.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ProjectDigestPreviewRequest
  2. API Source: customers_project_digest_config_preview
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { customersProjectDigestConfigPreview } from 'waldur-js-client';

try {
  const response = await customersProjectDigestConfigPreview({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "project_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
project_uuid string (uuid) ✓

200 -

Field Type
subject string
html_body string
text_body string

Send a test digest email

Send a test digest email to the requesting user.

1
2
3
4
http \
  POST \
  https://api.example.com/api/customers/a1b2c3d4-e5f6-7890-abcd-ef1234567890/project-digest-config/send-test/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.customers import customers_project_digest_config_send_test # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = customers_project_digest_config_send_test.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: customers_project_digest_config_send_test
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { customersProjectDigestConfigSendTest } from 'waldur-js-client';

try {
  const response = await customersProjectDigestConfigSendTest({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 - No response body

Organization Groups

An Organization group is a high-level classification used to group multiple Customers (Organizations) together. It provides an additional layer of administrative structure above the Customer level, allowing for a tree-like, hierarchical organization of customers into groups and sub-groups.

In practice, Organization Groups are a powerful tool for managing access control, applying policies, and generating aggregated reports across specific cohorts of customers.

Key Functions

  • Control Offering and Plan Visibility:
  • Offerings can be associated with one or more Organization Groups, making them exclusively available for ordering by Customers within those groups.

  • Similarly, pricing Plans can be restricted to specific Organization Groups. This allows service providers to create custom pricing tiers for different customer segments (e.g., educational institutions, commercial partners).

  • Apply Policies at Scale:

  • Policies, such as usage limits, can be targeted at an entire Organization Group. This allows for setting and enforcing aggregate consumption limits across all customers belonging to a group, rather than managing them individually.

  • Enable Aggregated Reporting and Analytics:

  • The API uses Organization Groups as a key dimension for statistical reporting. You can retrieve aggregated data, such as:
    • Active resource counts
    • Component usage metrics
    • User and project counts for service providers

  • This provides a high-level overview of usage and activity segmented by customer groups.

  • Manage Service Provider Data Visibility:

  • Permissions for service providers can be influenced by Organization Groups. For instance, a provider might gain visibility into user data or other resources related to offerings that are available to the organization groups their customers belong to.

Operations Summary

Method Endpoint Description
GET /api/organization-groups/ List Organization Groups
GET /api/organization-groups/{uuid}/ Retrieve
POST /api/organization-groups/ Create
PUT /api/organization-groups/{uuid}/ Update
PATCH /api/organization-groups/{uuid}/ Partial Update
DELETE /api/organization-groups/{uuid}/ Delete

List Organization Groups

1
2
3
4
http \
  GET \
  https://api.example.com/api/organization-groups/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.organization_groups import organization_groups_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = organization_groups_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: organization_groups_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { organizationGroupsList } from 'waldur-js-client';

try {
  const response = await organizationGroupsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
name string Name
name_exact string Name (exact)
o string Which field to use when ordering the results.
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
parent string (uuid) Parent UUID

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid)
url string (uri)
name string
parent_uuid string (uuid) UUID of the parent organization group
parent_name string Name of the parent organization group
parent string (uri)
customers_count integer Number of customers in this organization group

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/organization-groups/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.organization_groups import organization_groups_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = organization_groups_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: organization_groups_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { organizationGroupsRetrieve } from 'waldur-js-client';

try {
  const response = await organizationGroupsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
uuid string (uuid)
url string (uri)
name string
parent_uuid string (uuid) UUID of the parent organization group
parent_name string Name of the parent organization group
parent string (uri)
customers_count integer Number of customers in this organization group

Create

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/organization-groups/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-organization-group"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.organization_group_request import OrganizationGroupRequest # (1)
from waldur_api_client.api.organization_groups import organization_groups_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OrganizationGroupRequest(
    name="my-awesome-organization-group"
)
response = organization_groups_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OrganizationGroupRequest
  2. API Source: organization_groups_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { organizationGroupsCreate } from 'waldur-js-client';

try {
  const response = await organizationGroupsCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "name": "my-awesome-organization-group"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required
name string ✓
parent string (uri)

201 -

Field Type Description
uuid string (uuid)
url string (uri)
name string
parent_uuid string (uuid) UUID of the parent organization group
parent_name string Name of the parent organization group
parent string (uri)
customers_count integer Number of customers in this organization group

Update

1
2
3
4
5
http \
  PUT \
  https://api.example.com/api/organization-groups/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-organization-group"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.organization_group_request import OrganizationGroupRequest # (1)
from waldur_api_client.api.organization_groups import organization_groups_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OrganizationGroupRequest(
    name="my-awesome-organization-group"
)
response = organization_groups_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OrganizationGroupRequest
  2. API Source: organization_groups_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { organizationGroupsUpdate } from 'waldur-js-client';

try {
  const response = await organizationGroupsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-organization-group"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
name string ✓
parent string (uri)

200 -

Field Type Description
uuid string (uuid)
url string (uri)
name string
parent_uuid string (uuid) UUID of the parent organization group
parent_name string Name of the parent organization group
parent string (uri)
customers_count integer Number of customers in this organization group

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/organization-groups/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_organization_group_request import PatchedOrganizationGroupRequest # (1)
from waldur_api_client.api.organization_groups import organization_groups_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedOrganizationGroupRequest()
response = organization_groups_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedOrganizationGroupRequest
  2. API Source: organization_groups_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { organizationGroupsPartialUpdate } from 'waldur-js-client';

try {
  const response = await organizationGroupsPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
name string
parent string (uri)

200 -

Field Type Description
uuid string (uuid)
url string (uri)
name string
parent_uuid string (uuid) UUID of the parent organization group
parent_name string Name of the parent organization group
parent string (uri)
customers_count integer Number of customers in this organization group

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/organization-groups/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.organization_groups import organization_groups_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = organization_groups_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: organization_groups_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { organizationGroupsDestroy } from 'waldur-js-client';

try {
  const response = await organizationGroupsDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Project Types

Simple model for categorizing projects. Provides project type classification with name, description, and UUID identification. Used to categorize projects into different types for organizational purposes.

Operations Summary

Method Endpoint Description
GET /api/project-types/ List project types
GET /api/project-types/{uuid}/ Retrieve project type details

List project types

Retrieve a list of available project types.

1
2
3
4
http \
  GET \
  https://api.example.com/api/project-types/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.project_types import project_types_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = project_types_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: project_types_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { projectTypesList } from 'waldur-js-client';

try {
  const response = await projectTypesList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
name string Name
name_exact string Name (exact)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
uuid string (uuid)
url string (uri)
name string
description string

Retrieve project type details

Fetch details of a specific project type by its UUID.

1
2
3
4
http \
  GET \
  https://api.example.com/api/project-types/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.project_types import project_types_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = project_types_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: project_types_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { projectTypesRetrieve } from 'waldur-js-client';

try {
  const response = await projectTypesRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
uuid string (uuid)
url string (uri)
name string
description string

Projects

A Project is a workspace within a Customer used to organize cloud resources, manage team access, and track costs for a specific initiative or department. Every resource, such as a virtual machine or a database, must belong to a Project.

This entity acts as a scope for collaboration, allowing a subset of users from the parent Customer to work together with specific permissions.

Key Concepts

  • Hierarchical Structure: Every Project must belong to exactly one Customer. It cannot exist independently.
  • Resource Container: Projects are the direct parents of all provisioned resources in the cloud.
  • Team Collaboration: A Project has its own team of members with roles (e.g., Project Manager, Administrator) that are scoped only to that project.
  • Cost Tracking: While billing is handled by the parent Customer, costs are tracked on a per-project basis, enabling fine-grained financial reporting.

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/projects/ List projects
GET /api/projects/{uuid}/ Retrieve project details
POST /api/projects/ Create a new project
PUT /api/projects/{uuid}/ Update project details
PATCH /api/projects/{uuid}/ Partially update project details
DELETE /api/projects/{uuid}/ Delete a project
State Management
POST /api/projects/{uuid}/recover/ Recover a soft-deleted project
User Management
GET /api/projects/{uuid}/list_users/ List users and their roles in a scope
GET /api/projects/{project_uuid}/other_users/ Other users
POST /api/projects/{uuid}/add_user/ Grant a role to a user
POST /api/projects/{uuid}/delete_user/ Revoke a role from a user
POST /api/projects/{uuid}/update_user/ Update a user's role expiration
Configuration & Updates
POST /api/projects/{uuid}/move_project/ Move project to another customer
Data & Reporting
GET /api/projects/{uuid}/stats/ Get project resource usage statistics
Checklists
GET /api/projects/{uuid}/checklist/ Get checklist with questions and existing answers
GET /api/projects/checklist-template/ Get checklist template for creating new objects
GET /api/projects/{uuid}/completion_status/ Get checklist completion status
POST /api/projects/{uuid}/submit_answers/ Submit checklist answers
Remote Actions & Sync
POST /api/projects/{uuid}/sync_user_roles/ Sync user roles

Core CRUD

List projects

Retrieve a list of projects. The list is filtered based on the user's permissions. By default, only active projects are shown.

1
2
3
4
http \
  GET \
  https://api.example.com/api/projects/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.marketplace_provider_customer_project_o_enum import MarketplaceProviderCustomerProjectOEnum # (1)
from waldur_api_client.models.project_field_enum import ProjectFieldEnum # (2)
from waldur_api_client.api.projects import projects_list # (3)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = projects_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: MarketplaceProviderCustomerProjectOEnum
  2. Model Source: ProjectFieldEnum
  3. API Source: projects_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { projectsList } from 'waldur-js-client';

try {
  const response = await projectsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
accounting_is_running boolean Filter by whether accounting is running.
backend_id string
can_admin boolean Return a list of projects where current user is admin.
can_manage boolean Return a list of projects where current user is manager or a customer owner.
conceal_finished_projects boolean Conceal finished projects
created string (date-time) Created after
customer array Multiple values may be separated by commas.
customer_abbreviation string Customer abbreviation
customer_name string Customer name
customer_native_name string Customer native name
description string Description
field array
include_terminated boolean Include soft-deleted (terminated) projects. Only available to staff and support users, or users with organizational roles who can see their terminated projects.
is_removed boolean Is removed
modified string (date-time) Modified after
name string Name
name_exact string Name (exact)
o array Ordering
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
query string Filter by name, slug, UUID, backend ID or resource effective ID
slug string Slug
user_uuid string (uuid) Filter by user UUID.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
name string
slug string URL-friendly identifier. Only editable by staff users.
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_slug string
customer_native_name string
customer_abbreviation string
description string Project description (HTML content will be sanitized)
customer_display_billing_info_in_projects boolean
created string (date-time)
type string (uri)
type_name string
type_uuid string (uuid)
backend_id string
start_date string (date) Project start date. Cannot be edited after the start date has arrived.
end_date string (date) Project end date. Setting this field requires DELETE_PROJECT permission.
end_date_requested_by string (uri)
oecd_fos_2007_code any
oecd_fos_2007_label string Human-readable label for the OECD FOS 2007 classification code
is_industry boolean
image string (uri)
resources_count integer Number of active resources in this project
max_service_accounts integer Maximum number of service accounts allowed
kind any
is_removed boolean
termination_metadata any Metadata about project termination (read-only)
staff_notes string Internal notes visible only to staff and support users (HTML content will be sanitized)
grace_period_days integer Number of extra days after project end date before resources are terminated. Overrides customer-level setting.
user_email_patterns any
user_affiliations any
user_identity_sources any List of allowed identity sources (identity providers).
project_credit number (double)
marketplace_resource_count object (free-form)
billing_price_estimate any

Retrieve project details

Fetch the details of a specific project by its UUID. Users can access details of terminated projects they previously had access to.

1
2
3
4
http \
  GET \
  https://api.example.com/api/projects/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.project_field_enum import ProjectFieldEnum # (1)
from waldur_api_client.api.projects import projects_retrieve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = projects_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. Model Source: ProjectFieldEnum
  2. API Source: projects_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { projectsRetrieve } from 'waldur-js-client';

try {
  const response = await projectsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type
field array

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
slug string URL-friendly identifier. Only editable by staff users.
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_slug string
customer_native_name string
customer_abbreviation string
description string Project description (HTML content will be sanitized)
customer_display_billing_info_in_projects boolean
created string (date-time)
type string (uri)
type_name string
type_uuid string (uuid)
backend_id string
start_date string (date) Project start date. Cannot be edited after the start date has arrived.
end_date string (date) Project end date. Setting this field requires DELETE_PROJECT permission.
end_date_requested_by string (uri)
oecd_fos_2007_code any
oecd_fos_2007_label string Human-readable label for the OECD FOS 2007 classification code
is_industry boolean
image string (uri)
resources_count integer Number of active resources in this project
max_service_accounts integer Maximum number of service accounts allowed
kind any
is_removed boolean
termination_metadata any Metadata about project termination (read-only)
staff_notes string Internal notes visible only to staff and support users (HTML content will be sanitized)
grace_period_days integer Number of extra days after project end date before resources are terminated. Overrides customer-level setting.
user_email_patterns any
user_affiliations any
user_identity_sources any List of allowed identity sources (identity providers).
project_credit number (double)
marketplace_resource_count object (free-form)
billing_price_estimate any

Create a new project

A new project can be created by users with staff privilege (is_staff=True) or customer owners. Project resource quota is optional.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/projects/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-project" \
  customer="https://api.example.com/api/customer/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.project_request import ProjectRequest # (1)
from waldur_api_client.api.projects import projects_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ProjectRequest(
    name="my-awesome-project",
    customer="https://api.example.com/api/customer/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = projects_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ProjectRequest
  2. API Source: projects_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { projectsCreate } from 'waldur-js-client';

try {
  const response = await projectsCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "name": "my-awesome-project",
    "customer": "https://api.example.com/api/customer/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
name string ✓
slug string URL-friendly identifier. Only editable by staff users.
customer string (uri) ✓
description string Project description (HTML content will be sanitized)
type string (uri)
backend_id string
start_date string (date) Project start date. Cannot be edited after the start date has arrived.
end_date string (date) Project end date. Setting this field requires DELETE_PROJECT permission.
oecd_fos_2007_code any
is_industry boolean
image string (binary)
kind any
staff_notes string Internal notes visible only to staff and support users (HTML content will be sanitized)
grace_period_days integer Number of extra days after project end date before resources are terminated. Overrides customer-level setting.
user_email_patterns any
user_affiliations any
user_identity_sources any List of allowed identity sources (identity providers).

201 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
slug string URL-friendly identifier. Only editable by staff users.
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_slug string
customer_native_name string
customer_abbreviation string
description string Project description (HTML content will be sanitized)
customer_display_billing_info_in_projects boolean
created string (date-time)
type string (uri)
type_name string
type_uuid string (uuid)
backend_id string
start_date string (date) Project start date. Cannot be edited after the start date has arrived.
end_date string (date) Project end date. Setting this field requires DELETE_PROJECT permission.
end_date_requested_by string (uri)
oecd_fos_2007_code any
oecd_fos_2007_label string Human-readable label for the OECD FOS 2007 classification code
is_industry boolean
image string (uri)
resources_count integer Number of active resources in this project
max_service_accounts integer Maximum number of service accounts allowed
kind any
is_removed boolean
termination_metadata any Metadata about project termination (read-only)
staff_notes string Internal notes visible only to staff and support users (HTML content will be sanitized)
grace_period_days integer Number of extra days after project end date before resources are terminated. Overrides customer-level setting.
user_email_patterns any
user_affiliations any
user_identity_sources any List of allowed identity sources (identity providers).
project_credit number (double)
marketplace_resource_count object (free-form)
billing_price_estimate any

Update project details

Update the details of a project. Requires project administrator or customer owner permissions.

1
2
3
4
5
6
http \
  PUT \
  https://api.example.com/api/projects/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-project" \
  customer="https://api.example.com/api/customer/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.project_request import ProjectRequest # (1)
from waldur_api_client.api.projects import projects_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ProjectRequest(
    name="my-awesome-project",
    customer="https://api.example.com/api/customer/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = projects_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ProjectRequest
  2. API Source: projects_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { projectsUpdate } from 'waldur-js-client';

try {
  const response = await projectsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-project",
    "customer": "https://api.example.com/api/customer/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
name string ✓
slug string URL-friendly identifier. Only editable by staff users.
customer string (uri) ✓
description string Project description (HTML content will be sanitized)
type string (uri)
backend_id string
start_date string (date) Project start date. Cannot be edited after the start date has arrived.
end_date string (date) Project end date. Setting this field requires DELETE_PROJECT permission.
oecd_fos_2007_code any
is_industry boolean
image string (binary)
kind any
staff_notes string Internal notes visible only to staff and support users (HTML content will be sanitized)
grace_period_days integer Number of extra days after project end date before resources are terminated. Overrides customer-level setting.
user_email_patterns any
user_affiliations any
user_identity_sources any List of allowed identity sources (identity providers).

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
slug string URL-friendly identifier. Only editable by staff users.
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_slug string
customer_native_name string
customer_abbreviation string
description string Project description (HTML content will be sanitized)
customer_display_billing_info_in_projects boolean
created string (date-time)
type string (uri)
type_name string
type_uuid string (uuid)
backend_id string
start_date string (date) Project start date. Cannot be edited after the start date has arrived.
end_date string (date) Project end date. Setting this field requires DELETE_PROJECT permission.
end_date_requested_by string (uri)
oecd_fos_2007_code any
oecd_fos_2007_label string Human-readable label for the OECD FOS 2007 classification code
is_industry boolean
image string (uri)
resources_count integer Number of active resources in this project
max_service_accounts integer Maximum number of service accounts allowed
kind any
is_removed boolean
termination_metadata any Metadata about project termination (read-only)
staff_notes string Internal notes visible only to staff and support users (HTML content will be sanitized)
grace_period_days integer Number of extra days after project end date before resources are terminated. Overrides customer-level setting.
user_email_patterns any
user_affiliations any
user_identity_sources any List of allowed identity sources (identity providers).
project_credit number (double)
marketplace_resource_count object (free-form)
billing_price_estimate any

Partially update project details

Partially update the details of a project. Requires project administrator or customer owner permissions.

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/projects/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_project_request import PatchedProjectRequest # (1)
from waldur_api_client.api.projects import projects_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedProjectRequest()
response = projects_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedProjectRequest
  2. API Source: projects_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { projectsPartialUpdate } from 'waldur-js-client';

try {
  const response = await projectsPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
name string
slug string URL-friendly identifier. Only editable by staff users.
customer string (uri)
description string Project description (HTML content will be sanitized)
type string (uri)
backend_id string
start_date string (date) Project start date. Cannot be edited after the start date has arrived.
end_date string (date) Project end date. Setting this field requires DELETE_PROJECT permission.
oecd_fos_2007_code any
is_industry boolean
image string (binary)
kind any
staff_notes string Internal notes visible only to staff and support users (HTML content will be sanitized)
grace_period_days integer Number of extra days after project end date before resources are terminated. Overrides customer-level setting.
user_email_patterns any
user_affiliations any
user_identity_sources any List of allowed identity sources (identity providers).

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
slug string URL-friendly identifier. Only editable by staff users.
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_slug string
customer_native_name string
customer_abbreviation string
description string Project description (HTML content will be sanitized)
customer_display_billing_info_in_projects boolean
created string (date-time)
type string (uri)
type_name string
type_uuid string (uuid)
backend_id string
start_date string (date) Project start date. Cannot be edited after the start date has arrived.
end_date string (date) Project end date. Setting this field requires DELETE_PROJECT permission.
end_date_requested_by string (uri)
oecd_fos_2007_code any
oecd_fos_2007_label string Human-readable label for the OECD FOS 2007 classification code
is_industry boolean
image string (uri)
resources_count integer Number of active resources in this project
max_service_accounts integer Maximum number of service accounts allowed
kind any
is_removed boolean
termination_metadata any Metadata about project termination (read-only)
staff_notes string Internal notes visible only to staff and support users (HTML content will be sanitized)
grace_period_days integer Number of extra days after project end date before resources are terminated. Overrides customer-level setting.
user_email_patterns any
user_affiliations any
user_identity_sources any List of allowed identity sources (identity providers).
project_credit number (double)
marketplace_resource_count object (free-form)
billing_price_estimate any

Delete a project

Delete a project. If the project has any active resources, the deletion request will fail with a 409 Conflict response. This action performs a soft-delete, and the project can be recovered later.

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/projects/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.projects import projects_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = projects_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: projects_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { projectsDestroy } from 'waldur-js-client';

try {
  const response = await projectsDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

State Management

Recover a soft-deleted project

Recovers a soft-deleted (terminated) project, making it active again. Provides options to restore previous team members automatically (staff-only) or send them new invitations.

1
2
3
4
http \
  POST \
  https://api.example.com/api/projects/a1b2c3d4-e5f6-7890-abcd-ef1234567890/recover/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.project_recovery_request import ProjectRecoveryRequest # (1)
from waldur_api_client.api.projects import projects_recover # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ProjectRecoveryRequest()
response = projects_recover.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ProjectRecoveryRequest
  2. API Source: projects_recover
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { projectsRecover } from 'waldur-js-client';

try {
  const response = await projectsRecover({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
restore_team_members boolean Whether to automatically restore team members who had access before project deletion (staff only)
Constraints: default: False
send_invitations_to_previous_members boolean Whether to send invitations to users who had access before project deletion
Constraints: default: False
end_date string (date) End date for the recovered project

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
slug string URL-friendly identifier. Only editable by staff users.
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_slug string
customer_native_name string
customer_abbreviation string
description string Project description (HTML content will be sanitized)
customer_display_billing_info_in_projects boolean
created string (date-time)
type string (uri)
type_name string
type_uuid string (uuid)
backend_id string
start_date string (date) Project start date. Cannot be edited after the start date has arrived.
end_date string (date) Project end date. Setting this field requires DELETE_PROJECT permission.
end_date_requested_by string (uri)
oecd_fos_2007_code any
oecd_fos_2007_label string Human-readable label for the OECD FOS 2007 classification code
is_industry boolean
image string (uri)
resources_count integer Number of active resources in this project
max_service_accounts integer Maximum number of service accounts allowed
kind any
is_removed boolean
termination_metadata any Metadata about project termination (read-only)
staff_notes string Internal notes visible only to staff and support users (HTML content will be sanitized)
grace_period_days integer Number of extra days after project end date before resources are terminated. Overrides customer-level setting.
user_email_patterns any
user_affiliations any
user_identity_sources any List of allowed identity sources (identity providers).
project_credit number (double)
marketplace_resource_count object (free-form)
billing_price_estimate any

User Management

List users and their roles in a scope

Retrieves a list of users who have a role within a specific scope (e.g., a project or an organization). The list can be filtered by user details or role.

1
2
3
4
http \
  GET \
  https://api.example.com/api/projects/a1b2c3d4-e5f6-7890-abcd-ef1234567890/list_users/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.user_role_details_field_enum import UserRoleDetailsFieldEnum # (1)
from waldur_api_client.models.user_role_details_o_enum import UserRoleDetailsOEnum # (2)
from waldur_api_client.api.projects import projects_list_users_list # (3)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = projects_list_users_list.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

for item in response:
    print(item)
  1. Model Source: UserRoleDetailsFieldEnum
  2. Model Source: UserRoleDetailsOEnum
  3. API Source: projects_list_users_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { projectsListUsersList } from 'waldur-js-client';

try {
  const response = await projectsListUsersList({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type Description
field array Fields to include in response
full_name string User full name
native_name string User native name
o array Ordering fields
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
role string (uuid) Role UUID or name
search_string string Search string for user
user string (uuid) User UUID
user_slug string User slug
user_url string User URL
username string User username

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid)
created string (date-time)
expiration_time string (date-time)
role_name string
role_uuid string (uuid)
user_email string (email)
user_full_name string
user_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
user_uuid string (uuid)
user_image string (uri)
created_by_full_name string
created_by_uuid string (uuid)

Other users

A list of users which can be added to the current project from other projects of the same customer.

1
2
3
4
http \
  GET \
  https://api.example.com/api/projects/a1b2c3d4-e5f6-7890-abcd-ef1234567890/other_users/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.customer_user_o_enum import CustomerUserOEnum # (1)
from waldur_api_client.api.projects import projects_other_users_list # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = projects_other_users_list.sync(
    project_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

for item in response:
    print(item)
  1. Model Source: CustomerUserOEnum
  2. API Source: projects_other_users_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { projectsOtherUsersList } from 'waldur-js-client';

try {
  const response = await projectsOtherUsersList({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "project_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
project_uuid string (uuid) ✓ UUID of the project
Name Type Description
agreement_date string (date-time) Agreement date after
civil_number string
date_joined string (date-time) Date joined after
description string
email string Email
full_name string Full name
is_active boolean Is active
job_title string Job title
modified string (date-time) Date modified after
native_name string Native name
o string Ordering. Sort by a combination of first name, last name, and username.
Enum: concatenated_name, -concatenated_name
organization string Organization
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
phone_number string
registration_method string
user_keyword string User keyword
username string Username

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
full_name string
native_name string
email string (email)
image string (uri)

Grant a role to a user

Assigns a specific role to a user within the current scope. An optional expiration time for the role can be set.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/projects/a1b2c3d4-e5f6-7890-abcd-ef1234567890/add_user/ \
  Authorization:"Token YOUR_API_TOKEN" \
  role="string-value" \
  user="a1b2c3d4-e5f6-7890-abcd-ef1234567890"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.user_role_create_request import UserRoleCreateRequest # (1)
from waldur_api_client.api.projects import projects_add_user # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = UserRoleCreateRequest(
    role="string-value",
    user="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
)
response = projects_add_user.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: UserRoleCreateRequest
  2. API Source: projects_add_user
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { projectsAddUser } from 'waldur-js-client';

try {
  const response = await projectsAddUser({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "role": "string-value",
    "user": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
role string ✓
user string (uuid) ✓
expiration_time string (date-time)

201 -

Field Type
expiration_time string (date-time)

400 - Validation error, for example when trying to add a user to a terminated project.

Revoke a role from a user

Removes a specific role from a user within the current scope. This effectively revokes their permissions associated with that role.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/projects/a1b2c3d4-e5f6-7890-abcd-ef1234567890/delete_user/ \
  Authorization:"Token YOUR_API_TOKEN" \
  role="string-value" \
  user="a1b2c3d4-e5f6-7890-abcd-ef1234567890"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.user_role_delete_request import UserRoleDeleteRequest # (1)
from waldur_api_client.api.projects import projects_delete_user # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = UserRoleDeleteRequest(
    role="string-value",
    user="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
)
response = projects_delete_user.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: UserRoleDeleteRequest
  2. API Source: projects_delete_user
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { projectsDeleteUser } from 'waldur-js-client';

try {
  const response = await projectsDeleteUser({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "role": "string-value",
    "user": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
role string ✓
user string (uuid) ✓
expiration_time string (date-time)

200 - Role revoked successfully.

Update a user's role expiration

Updates the expiration time for a user's existing role in the current scope. This is useful for extending or shortening the duration of a permission. To make a role permanent, set expiration_time to null.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/projects/a1b2c3d4-e5f6-7890-abcd-ef1234567890/update_user/ \
  Authorization:"Token YOUR_API_TOKEN" \
  role="string-value" \
  user="a1b2c3d4-e5f6-7890-abcd-ef1234567890"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.user_role_update_request import UserRoleUpdateRequest # (1)
from waldur_api_client.api.projects import projects_update_user # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = UserRoleUpdateRequest(
    role="string-value",
    user="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
)
response = projects_update_user.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: UserRoleUpdateRequest
  2. API Source: projects_update_user
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { projectsUpdateUser } from 'waldur-js-client';

try {
  const response = await projectsUpdateUser({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "role": "string-value",
    "user": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
role string ✓
user string (uuid) ✓
expiration_time string (date-time)

200 -

Field Type
expiration_time string (date-time)

Configuration & Updates

Move project to another customer

Moves a project and its associated resources to a different customer. You can choose whether to preserve existing project permissions for users. Terminated projects can also be moved.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/projects/a1b2c3d4-e5f6-7890-abcd-ef1234567890/move_project/ \
  Authorization:"Token YOUR_API_TOKEN" \
  customer="https://api.example.com/api/customer/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  preserve_permissions=true

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.move_project_request import MoveProjectRequest # (1)
from waldur_api_client.api.projects import projects_move_project # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = MoveProjectRequest(
    customer="https://api.example.com/api/customer/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    preserve_permissions=true
)
response = projects_move_project.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: MoveProjectRequest
  2. API Source: projects_move_project
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { projectsMoveProject } from 'waldur-js-client';

try {
  const response = await projectsMoveProject({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "customer": "https://api.example.com/api/customer/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "preserve_permissions": true
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
customer string (uri) ✓
preserve_permissions boolean ✓

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
slug string URL-friendly identifier. Only editable by staff users.
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_slug string
customer_native_name string
customer_abbreviation string
description string Project description (HTML content will be sanitized)
customer_display_billing_info_in_projects boolean
created string (date-time)
type string (uri)
type_name string
type_uuid string (uuid)
backend_id string
start_date string (date) Project start date. Cannot be edited after the start date has arrived.
end_date string (date) Project end date. Setting this field requires DELETE_PROJECT permission.
end_date_requested_by string (uri)
oecd_fos_2007_code any
oecd_fos_2007_label string Human-readable label for the OECD FOS 2007 classification code
is_industry boolean
image string (uri)
resources_count integer Number of active resources in this project
max_service_accounts integer Maximum number of service accounts allowed
kind any
is_removed boolean
termination_metadata any Metadata about project termination (read-only)
staff_notes string Internal notes visible only to staff and support users (HTML content will be sanitized)
grace_period_days integer Number of extra days after project end date before resources are terminated. Overrides customer-level setting.
user_email_patterns any
user_affiliations any
user_identity_sources any List of allowed identity sources (identity providers).
project_credit number (double)
marketplace_resource_count object (free-form)
billing_price_estimate any

Data & Reporting

Get project resource usage statistics

Provides statistics about the resource usage (e.g., CPU, RAM, storage) for all resources within a project. Can be filtered to show usage for the current month only.

1
2
3
4
http \
  GET \
  https://api.example.com/api/projects/a1b2c3d4-e5f6-7890-abcd-ef1234567890/stats/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.projects import projects_stats_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = projects_stats_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: projects_stats_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { projectsStatsRetrieve } from 'waldur-js-client';

try {
  const response = await projectsStatsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type Description
for_current_month boolean If true, returns usage data for the current month only. Otherwise, returns total usage.

200 -

Field Type
components array of objects
components.type string
components.name string
components.description string
components.measured_unit string
components.billing_type string
components.usage integer
components.limit_usage integer
components.limit integer
components.offering_name string
components.offering_uuid string (uuid)

Checklists

Get checklist with questions and existing answers

Get checklist with questions and existing answers.

1
2
3
4
http \
  GET \
  https://api.example.com/api/projects/a1b2c3d4-e5f6-7890-abcd-ef1234567890/checklist/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.projects import projects_checklist_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = projects_checklist_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: projects_checklist_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { projectsChecklistRetrieve } from 'waldur-js-client';

try {
  const response = await projectsChecklistRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type Description
include_all boolean If true, returns all questions including hidden ones (for dynamic form visibility). Default: false.

200 -

Field Type Description
checklist object (free-form)
completion object
completion.uuid string (uuid)
completion.is_completed boolean Whether all required questions have been answered
completion.completion_percentage number (double)
completion.unanswered_required_questions array of anys
completion.checklist_name string
completion.checklist_description string
completion.created string (date-time)
completion.modified string (date-time)
questions array of objects
questions.uuid string (uuid)
questions.description string
questions.user_guidance string
questions.question_type any Type of question and expected answer format
questions.required boolean
questions.order integer
questions.existing_answer object (free-form)
questions.question_options array of anys
questions.min_value string (decimal) Minimum value allowed for NUMBER, YEAR, and RATING type questions
questions.max_value string (decimal) Maximum value allowed for NUMBER, YEAR, and RATING type questions
questions.allowed_file_types any List of allowed file extensions (e.g., ['.pdf', '.doc', '.docx']). If empty, all file types are allowed.
questions.allowed_mime_types any List of allowed MIME types (e.g., ['application/pdf', 'application/msword']). If empty, MIME type validation is not enforced. When both extensions and MIME types are specified, files must match both criteria for security.
questions.max_file_size_mb integer Maximum file size in megabytes. If not set, no size limit is enforced.
questions.max_files_count integer Maximum number of files allowed for MULTIPLE_FILES type questions. If not set, no count limit is enforced.
questions.dependencies_info object (free-form)

400 -

404 -

Get checklist template for creating new objects

Get checklist template for creating new objects.

1
2
3
4
5
http \
  GET \
  https://api.example.com/api/projects/checklist-template/ \
  Authorization:"Token YOUR_API_TOKEN" \
  parent_uuid=="a1b2c3d4-e5f6-7890-abcd-ef1234567890"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.projects import projects_checklist_template_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = projects_checklist_template_retrieve.sync(
    client=client,
    parent_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
)

print(response)
  1. API Source: projects_checklist_template_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { projectsChecklistTemplateRetrieve } from 'waldur-js-client';

try {
  const response = await projectsChecklistTemplateRetrieve({
  auth: "Token YOUR_API_TOKEN",
  query: {
    "parent_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
parent_uuid string (uuid) ✓ UUID of the parent object (e.g., customer UUID for new projects)

200 -

Field Type Description
checklist object (free-form)
questions array of objects
questions.uuid string (uuid)
questions.required boolean
questions.description string
questions.user_guidance string Additional guidance text visible to users when answering and reviewing
questions.question_options array of objects
questions.question_options.uuid string (uuid)
questions.question_options.label string
questions.question_options.order integer
questions.question_type any Type of question and expected answer format
questions.order integer
questions.min_value string (decimal) Minimum value allowed for NUMBER, YEAR, and RATING type questions
questions.max_value string (decimal) Maximum value allowed for NUMBER, YEAR, and RATING type questions
questions.allowed_file_types any List of allowed file extensions (e.g., ['.pdf', '.doc', '.docx']). If empty, all file types are allowed.
questions.allowed_mime_types any List of allowed MIME types (e.g., ['application/pdf', 'application/msword']). If empty, MIME type validation is not enforced. When both extensions and MIME types are specified, files must match both criteria for security.
questions.max_file_size_mb integer Maximum file size in megabytes. If not set, no size limit is enforced.
questions.max_files_count integer Maximum number of files allowed for MULTIPLE_FILES type questions. If not set, no count limit is enforced.
questions.operator any
questions.review_answer_value any Answer value that trigger review.
questions.always_requires_review boolean This question always requires review regardless of answer
questions.guidance_answer_value any Answer value that triggers display of user guidance.
questions.guidance_operator any Operator to use when comparing answer with guidance_answer_value
questions.always_show_guidance boolean Show user guidance always, regardless of answer. If False, guidance is conditional on answer matching guidance_answer_value with guidance_operator
questions.dependency_logic_operator any Defines how multiple dependencies are evaluated. AND: All dependencies must be satisfied. OR: At least one dependency must be satisfied.
initial_visible_questions array of objects
initial_visible_questions.uuid string (uuid)
initial_visible_questions.required boolean
initial_visible_questions.description string
initial_visible_questions.user_guidance string Additional guidance text visible to users when answering and reviewing
initial_visible_questions.question_options array of objects
initial_visible_questions.question_options.uuid string (uuid)
initial_visible_questions.question_options.label string
initial_visible_questions.question_options.order integer
initial_visible_questions.question_type any Type of question and expected answer format
initial_visible_questions.order integer
initial_visible_questions.min_value string (decimal) Minimum value allowed for NUMBER, YEAR, and RATING type questions
initial_visible_questions.max_value string (decimal) Maximum value allowed for NUMBER, YEAR, and RATING type questions
initial_visible_questions.allowed_file_types any List of allowed file extensions (e.g., ['.pdf', '.doc', '.docx']). If empty, all file types are allowed.
initial_visible_questions.allowed_mime_types any List of allowed MIME types (e.g., ['application/pdf', 'application/msword']). If empty, MIME type validation is not enforced. When both extensions and MIME types are specified, files must match both criteria for security.
initial_visible_questions.max_file_size_mb integer Maximum file size in megabytes. If not set, no size limit is enforced.
initial_visible_questions.max_files_count integer Maximum number of files allowed for MULTIPLE_FILES type questions. If not set, no count limit is enforced.
initial_visible_questions.operator any
initial_visible_questions.review_answer_value any Answer value that trigger review.
initial_visible_questions.always_requires_review boolean This question always requires review regardless of answer
initial_visible_questions.guidance_answer_value any Answer value that triggers display of user guidance.
initial_visible_questions.guidance_operator any Operator to use when comparing answer with guidance_answer_value
initial_visible_questions.always_show_guidance boolean Show user guidance always, regardless of answer. If False, guidance is conditional on answer matching guidance_answer_value with guidance_operator
initial_visible_questions.dependency_logic_operator any Defines how multiple dependencies are evaluated. AND: All dependencies must be satisfied. OR: At least one dependency must be satisfied.

400 -

404 -

Get checklist completion status

Get checklist completion status.

1
2
3
4
http \
  GET \
  https://api.example.com/api/projects/a1b2c3d4-e5f6-7890-abcd-ef1234567890/completion_status/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.projects import projects_completion_status_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = projects_completion_status_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: projects_completion_status_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { projectsCompletionStatusRetrieve } from 'waldur-js-client';

try {
  const response = await projectsCompletionStatusRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
uuid string (uuid)
is_completed boolean Whether all required questions have been answered
completion_percentage number (double)
unanswered_required_questions array of anys
checklist_name string
checklist_description string
created string (date-time)
modified string (date-time)

400 -

404 -

Submit checklist answers

Submit checklist answers.

1
2
3
4
echo '[{"question_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "answer_data": null}]' | http \
  POST \
  https://api.example.com/api/projects/a1b2c3d4-e5f6-7890-abcd-ef1234567890/submit_answers/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.projects import projects_submit_answers # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = projects_submit_answers.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: projects_submit_answers
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { projectsSubmitAnswers } from 'waldur-js-client';

try {
  const response = await projectsSubmitAnswers({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: [{"question_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "answer_data": null}]
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

The request body is an array of objects, where each object has the following structure:

Field Type Required
question_uuid string (uuid) ✓
answer_data any ✓

200 -

Field Type Description
detail string
completion object
completion.uuid string (uuid)
completion.is_completed boolean Whether all required questions have been answered
completion.completion_percentage number (double)
completion.unanswered_required_questions array of anys
completion.checklist_name string
completion.checklist_description string
completion.created string (date-time)
completion.modified string (date-time)

400 -

404 -

Remote Actions & Sync

Sync user roles

Trigger user role sync for this project. Sends a notification to RabbitMQ that this project needs user role synchronization.

1
2
3
4
http \
  POST \
  https://api.example.com/api/projects/string-value/sync_user_roles/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.projects import projects_sync_user_roles # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = projects_sync_user_roles.sync(
    uuid="string-value",
    client=client
)

print(response)
  1. API Source: projects_sync_user_roles
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { projectsSyncUserRoles } from 'waldur-js-client';

try {
  const response = await projectsSyncUserRoles({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string ✓

200 - No response body

Roles

Roles are named collections of permissions that define what a user is allowed to do within a specific scope (either a Customer or a Project). They are the cornerstone of the platform's Role-Based Access Control (RBAC) system.

A user's effective permissions are determined by the combination of their assigned role and the scope to which it applies.

The Permission Triplet

Access control is defined by a triplet: (User, Role, Scope).

  • User: Who is performing the action?

  • Role: What can they do? (e.g., Project Administrator, Customer Owner)

  • Scope: Where can they do it? (e.g., on "Project Alpha" or across the entire "Customer Inc.")

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/roles/ List roles
GET /api/roles/{uuid}/ Get role details
POST /api/roles/ Create a new role
PUT /api/roles/{uuid}/ Update a role
PUT /api/roles/{uuid}/update_descriptions/ Update role descriptions
PATCH /api/roles/{uuid}/ Partial Update
DELETE /api/roles/{uuid}/ Delete a role
Other Actions
POST /api/roles/{uuid}/disable/ Disable a role
POST /api/roles/{uuid}/enable/ Enable a role

Core CRUD

List roles

Get a list of all available roles.

1
2
3
4
http \
  GET \
  https://api.example.com/api/roles/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.role_details_field_enum import RoleDetailsFieldEnum # (1)
from waldur_api_client.api.roles import roles_list # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = roles_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: RoleDetailsFieldEnum
  2. API Source: roles_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { rolesList } from 'waldur-js-client';

try {
  const response = await rolesList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
description string
field array
is_active boolean
name string
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
uuid string (uuid)
name string
description string
description_en string
description_et string
description_lt string
description_lv string
description_ru string
description_it string
description_de string
description_da string
description_sv string
description_es string
description_fr string
description_nb string
description_ar string
description_cs string
permissions array of strings
is_system_role boolean
is_active boolean
users_count integer
content_type any

Get role details

Retrieve the details of a specific role by its UUID.

1
2
3
4
http \
  GET \
  https://api.example.com/api/roles/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.role_details_field_enum import RoleDetailsFieldEnum # (1)
from waldur_api_client.api.roles import roles_retrieve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = roles_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. Model Source: RoleDetailsFieldEnum
  2. API Source: roles_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { rolesRetrieve } from 'waldur-js-client';

try {
  const response = await rolesRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type
field array

200 -

Field Type
uuid string (uuid)
name string
description string
description_en string
description_et string
description_lt string
description_lv string
description_ru string
description_it string
description_de string
description_da string
description_sv string
description_es string
description_fr string
description_nb string
description_ar string
description_cs string
permissions array of strings
is_system_role boolean
is_active boolean
users_count integer
content_type any

Create a new role

Allows staff users to create a new custom role with a specific set of permissions.

1
2
3
4
5
6
7
http \
  POST \
  https://api.example.com/api/roles/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-role" \
  permissions=null \
  content_type="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.role_modify_request import RoleModifyRequest # (1)
from waldur_api_client.api.roles import roles_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = RoleModifyRequest(
    name="my-awesome-role",
    permissions=null,
    content_type="string-value"
)
response = roles_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: RoleModifyRequest
  2. API Source: roles_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
import { rolesCreate } from 'waldur-js-client';

try {
  const response = await rolesCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "name": "my-awesome-role",
    "permissions": null,
    "content_type": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required
name string ✓
description string
description_en string
description_et string
description_lt string
description_lv string
description_ru string
description_it string
description_de string
description_da string
description_sv string
description_es string
description_fr string
description_nb string
description_ar string
description_cs string
permissions any ✓
is_active boolean
content_type string ✓

201 -

Field Type
uuid string (uuid)
name string
description string
description_en string
description_et string
description_lt string
description_lv string
description_ru string
description_it string
description_de string
description_da string
description_sv string
description_es string
description_fr string
description_nb string
description_ar string
description_cs string
permissions array of strings
is_system_role boolean
is_active boolean
users_count integer
content_type any

Update a role

Allows staff users to update an existing role's name, description, content type, and permissions. The name of a system role cannot be changed.

1
2
3
4
5
6
7
http \
  PUT \
  https://api.example.com/api/roles/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-role" \
  permissions=null \
  content_type="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.role_modify_request import RoleModifyRequest # (1)
from waldur_api_client.api.roles import roles_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = RoleModifyRequest(
    name="my-awesome-role",
    permissions=null,
    content_type="string-value"
)
response = roles_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: RoleModifyRequest
  2. API Source: roles_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
import { rolesUpdate } from 'waldur-js-client';

try {
  const response = await rolesUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-role",
    "permissions": null,
    "content_type": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
name string ✓
description string
description_en string
description_et string
description_lt string
description_lv string
description_ru string
description_it string
description_de string
description_da string
description_sv string
description_es string
description_fr string
description_nb string
description_ar string
description_cs string
permissions any ✓
is_active boolean
content_type string ✓

200 -

Field Type
uuid string (uuid)
name string
description string
description_en string
description_et string
description_lt string
description_lv string
description_ru string
description_it string
description_de string
description_da string
description_sv string
description_es string
description_fr string
description_nb string
description_ar string
description_cs string
permissions array of strings
is_system_role boolean
is_active boolean
users_count integer
content_type any

Update role descriptions

Allows staff users to update the multilingual descriptions of a role.

1
2
3
4
http \
  PUT \
  https://api.example.com/api/roles/a1b2c3d4-e5f6-7890-abcd-ef1234567890/update_descriptions/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.role_description_request import RoleDescriptionRequest # (1)
from waldur_api_client.api.roles import roles_update_descriptions_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = RoleDescriptionRequest()
response = roles_update_descriptions_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: RoleDescriptionRequest
  2. API Source: roles_update_descriptions_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { rolesUpdateDescriptionsUpdate } from 'waldur-js-client';

try {
  const response = await rolesUpdateDescriptionsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
description string
description_en string
description_et string
description_lt string
description_lv string
description_ru string
description_it string
description_de string
description_da string
description_sv string
description_es string
description_fr string
description_nb string
description_ar string
description_cs string

200 -

Field Type
description string
description_en string
description_et string
description_lt string
description_lv string
description_ru string
description_it string
description_de string
description_da string
description_sv string
description_es string
description_fr string
description_nb string
description_ar string
description_cs string

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/roles/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_role_details_request import PatchedRoleDetailsRequest # (1)
from waldur_api_client.api.roles import roles_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedRoleDetailsRequest()
response = roles_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedRoleDetailsRequest
  2. API Source: roles_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { rolesPartialUpdate } from 'waldur-js-client';

try {
  const response = await rolesPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
name string
description string
description_en string
description_et string
description_lt string
description_lv string
description_ru string
description_it string
description_de string
description_da string
description_sv string
description_es string
description_fr string
description_nb string
description_ar string
description_cs string
is_active boolean

200 -

Field Type
uuid string (uuid)
name string
description string
description_en string
description_et string
description_lt string
description_lv string
description_ru string
description_it string
description_de string
description_da string
description_sv string
description_es string
description_fr string
description_nb string
description_ar string
description_cs string
permissions array of strings
is_system_role boolean
is_active boolean
users_count integer
content_type any

Delete a role

Allows staff users to delete a custom role. System roles and roles that are currently in use cannot be deleted.

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/roles/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.roles import roles_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = roles_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: roles_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { rolesDestroy } from 'waldur-js-client';

try {
  const response = await rolesDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Other Actions

Disable a role

Allows staff users to disable a role, preventing it from being assigned further. Existing assignments are not affected.

1
2
3
4
http \
  POST \
  https://api.example.com/api/roles/a1b2c3d4-e5f6-7890-abcd-ef1234567890/disable/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.roles import roles_disable # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = roles_disable.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: roles_disable
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { rolesDisable } from 'waldur-js-client';

try {
  const response = await rolesDisable({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 - Role disabled successfully.

Enable a role

Allows staff users to enable a role, making it available for assignment.

1
2
3
4
http \
  POST \
  https://api.example.com/api/roles/a1b2c3d4-e5f6-7890-abcd-ef1234567890/enable/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.roles import roles_enable # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = roles_enable.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: roles_enable
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { rolesEnable } from 'waldur-js-client';

try {
  const response = await rolesEnable({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 - Role enabled successfully.

Users

A User represents an individual person's account within the system. It is the primary entity for authentication and identity.

A User object on its own has limited capabilities beyond logging in and managing personal details like SSH keys. Its power comes from the roles and permissions it is granted within the scope of a Customer or Project.

User vs. Permissions

It is crucial to distinguish between the User entity and its permissions. The User API allows for managing the account itself (e.g., name, email), while team management is handled through the add_user actions on the Customer and Project endpoints.

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/users/ List Users
GET /api/users/{uuid}/ Retrieve
POST /api/users/ Create
POST /api/users/{uuid}/pull_remote_user/ Synchronize user details from eduTEAMS
POST /api/users/{uuid}/update_actions/ Recalculate user actions for a specific user
PUT /api/users/{uuid}/ Update
PATCH /api/users/{uuid}/ Partial Update
DELETE /api/users/{uuid}/ Delete
Other Actions
GET /api/users/{uuid}/data_access_history/ Get user data access history
GET /api/users/{uuid}/data_access/ Get user data access visibility
GET /api/users/{uuid}/history/at/ Get object state at a specific timestamp
GET /api/users/{uuid}/history/ Get version history
GET /api/users/{uuid}/identity_bridge_status/ Get identity bridge status for a user
GET /api/users/me/ Get current user details
GET /api/users/profile_completeness/ Check profile completeness
GET /api/users/{uuid}/token/ Get user auth token
GET /api/users/user_active_status_count/ Get user counts by active status
GET /api/users/user_language_count/ Get user counts by preferred language
GET /api/users/user_registration_trend/ Get user registration trends by month
POST /api/users/{uuid}/cancel_change_email/ Cancel email change request
POST /api/users/{uuid}/change_email/ Request email change
POST /api/users/{uuid}/change_password/ Change user password
POST /api/users/confirm_email/ Confirm email change
POST /api/users/{uuid}/refresh_token/ Refresh user auth token
POST /api/users/scim_sync_all/ Trigger SCIM synchronization for all users
POST /api/users/{uuid}/send_notification/ Send action notification to a specific user

Core CRUD

List Users

1
2
3
4
http \
  GET \
  https://api.example.com/api/users/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.marketplace_service_provider_user_o_enum import MarketplaceServiceProviderUserOEnum # (1)
from waldur_api_client.models.user_field_enum import UserFieldEnum # (2)
from waldur_api_client.api.users import users_list # (3)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = users_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: MarketplaceServiceProviderUserOEnum
  2. Model Source: UserFieldEnum
  3. API Source: users_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { usersList } from 'waldur-js-client';

try {
  const response = await usersList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
agreement_date string (date-time) Agreement date after
civil_number string
customer_uuid string (uuid) Customer UUID
date_joined string (date-time) Date joined after
description string
email string Email
field array
full_name string Full name
is_active boolean Is active
is_staff boolean Is staff
is_support boolean Is support
job_title string Job title
modified string (date-time) Date modified after
native_name string Native name
o array Ordering
organization string Organization
organization_roles string Organization roles
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
phone_number string
project_roles string Project roles
project_uuid string (uuid) Project UUID
query string Filter by first name, last name, civil number, username or email
registration_method string
user_keyword string User keyword
username string Username (exact)
username_list string Comma-separated usernames

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
slug string URL-friendly identifier. Only editable by staff users.
full_name string
native_name string
job_title string
email string (email)
phone_number string
organization string
civil_number string
description string
is_staff boolean Designates whether the user can log into this admin site.
is_active boolean Designates whether this user should be treated as active. Unselect this instead of deleting accounts.
is_support boolean Designates whether the user is a global support user.
token string
token_lifetime integer Token lifetime in seconds.
token_expires_at string (date-time)
registration_method string Indicates what registration method was used.
date_joined string (date-time)
agreement_date string (date-time) Indicates when the user has agreed with the policy.
notifications_enabled boolean Designates whether the user is allowed to receive email notifications.
preferred_language string
permissions array of objects
permissions.user_uuid string (uuid)
permissions.user_name string
permissions.user_slug string
permissions.created string (date-time)
permissions.expiration_time string (date-time)
permissions.created_by_full_name string
permissions.created_by_username string
permissions.role_name string
permissions.role_description string
permissions.role_uuid string (uuid)
permissions.scope_type string
permissions.scope_uuid string (uuid)
permissions.scope_name string
permissions.customer_uuid string (uuid)
permissions.customer_name string
requested_email string
affiliations any Person's affiliation within organization such as student, faculty, staff.
first_name string
last_name string
birth_date string (date)
identity_provider_name string
identity_provider_label string
identity_provider_management_url string
identity_provider_fields array of strings
image string (uri)
identity_source string Indicates what identity provider was used.
has_active_session boolean
ip_address string
gender any ISO 5218 gender code
personal_title string Honorific title (Mr, Ms, Dr, Prof, etc.)
place_of_birth string
country_of_residence string
nationality string Primary citizenship (ISO 3166-1 alpha-2 code)
nationalities any List of all citizenships (ISO 3166-1 alpha-2 codes)
organization_country string
organization_type string SCHAC URN (e.g., urn:schac:homeOrganizationType:int:university)
organization_registry_code string Company registration code of the user's organization, if known
eduperson_assurance any REFEDS assurance profile URIs from identity provider
is_identity_manager boolean Designates whether the user is allowed to manage remote user identities.
attribute_sources any Per-attribute source and freshness tracking. Format: {'field_name': {'source': 'isd:', 'timestamp': 'ISO8601'}}.
managed_isds any List of ISD source identifiers this user can manage via Identity Bridge. E.g., ['isd:puhuri', 'isd:fenix']. Non-empty list implies identity manager role.
active_isds any List of ISDs that have asserted this user exists. User is deactivated when this becomes empty.

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/users/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.user_field_enum import UserFieldEnum # (1)
from waldur_api_client.api.users import users_retrieve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = users_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. Model Source: UserFieldEnum
  2. API Source: users_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { usersRetrieve } from 'waldur-js-client';

try {
  const response = await usersRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type
field array

200 -

Field Type Description
url string (uri)
uuid string (uuid)
username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
slug string URL-friendly identifier. Only editable by staff users.
full_name string
native_name string
job_title string
email string (email)
phone_number string
organization string
civil_number string
description string
is_staff boolean Designates whether the user can log into this admin site.
is_active boolean Designates whether this user should be treated as active. Unselect this instead of deleting accounts.
is_support boolean Designates whether the user is a global support user.
token string
token_lifetime integer Token lifetime in seconds.
token_expires_at string (date-time)
registration_method string Indicates what registration method was used.
date_joined string (date-time)
agreement_date string (date-time) Indicates when the user has agreed with the policy.
notifications_enabled boolean Designates whether the user is allowed to receive email notifications.
preferred_language string
permissions array of objects
permissions.user_uuid string (uuid)
permissions.user_name string
permissions.user_slug string
permissions.created string (date-time)
permissions.expiration_time string (date-time)
permissions.created_by_full_name string
permissions.created_by_username string
permissions.role_name string
permissions.role_description string
permissions.role_uuid string (uuid)
permissions.scope_type string
permissions.scope_uuid string (uuid)
permissions.scope_name string
permissions.customer_uuid string (uuid)
permissions.customer_name string
requested_email string
affiliations any Person's affiliation within organization such as student, faculty, staff.
first_name string
last_name string
birth_date string (date)
identity_provider_name string
identity_provider_label string
identity_provider_management_url string
identity_provider_fields array of strings
image string (uri)
identity_source string Indicates what identity provider was used.
has_active_session boolean
ip_address string
gender any ISO 5218 gender code
personal_title string Honorific title (Mr, Ms, Dr, Prof, etc.)
place_of_birth string
country_of_residence string
nationality string Primary citizenship (ISO 3166-1 alpha-2 code)
nationalities any List of all citizenships (ISO 3166-1 alpha-2 codes)
organization_country string
organization_type string SCHAC URN (e.g., urn:schac:homeOrganizationType:int:university)
organization_registry_code string Company registration code of the user's organization, if known
eduperson_assurance any REFEDS assurance profile URIs from identity provider
is_identity_manager boolean Designates whether the user is allowed to manage remote user identities.
attribute_sources any Per-attribute source and freshness tracking. Format: {'field_name': {'source': 'isd:', 'timestamp': 'ISO8601'}}.
managed_isds any List of ISD source identifiers this user can manage via Identity Bridge. E.g., ['isd:puhuri', 'isd:fenix']. Non-empty list implies identity manager role.
active_isds any List of ISDs that have asserted this user exists. User is deactivated when this becomes empty.

Create

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/users/ \
  Authorization:"Token YOUR_API_TOKEN" \
  username="alice" \
  email="alice@example.com"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.user_request import UserRequest # (1)
from waldur_api_client.api.users import users_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = UserRequest(
    username="alice",
    email="alice@example.com"
)
response = users_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: UserRequest
  2. API Source: users_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { usersCreate } from 'waldur-js-client';

try {
  const response = await usersCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "username": "alice",
    "email": "alice@example.com"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
username string ✓ Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
slug string URL-friendly identifier. Only editable by staff users.
native_name string
job_title string
email string (email) ✓
phone_number string
organization string
description string
is_staff boolean Designates whether the user can log into this admin site.
is_active boolean Designates whether this user should be treated as active. Unselect this instead of deleting accounts.
is_support boolean Designates whether the user is a global support user.
token_lifetime integer Token lifetime in seconds.
agree_with_policy boolean User must agree with the policy to register.
Constraints: write-only
notifications_enabled boolean Designates whether the user is allowed to receive email notifications.
preferred_language string
first_name string
last_name string
birth_date string (date)
image string (binary)
gender any ISO 5218 gender code
personal_title string Honorific title (Mr, Ms, Dr, Prof, etc.)
place_of_birth string
country_of_residence string
nationality string Primary citizenship (ISO 3166-1 alpha-2 code)
nationalities any List of all citizenships (ISO 3166-1 alpha-2 codes)
organization_country string
organization_type string SCHAC URN (e.g., urn:schac:homeOrganizationType:int:university)
organization_registry_code string Company registration code of the user's organization, if known
eduperson_assurance any REFEDS assurance profile URIs from identity provider
is_identity_manager boolean Designates whether the user is allowed to manage remote user identities.
managed_isds any List of ISD source identifiers this user can manage via Identity Bridge. E.g., ['isd:puhuri', 'isd:fenix']. Non-empty list implies identity manager role.

201 -

Field Type Description
url string (uri)
uuid string (uuid)
username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
slug string URL-friendly identifier. Only editable by staff users.
full_name string
native_name string
job_title string
email string (email)
phone_number string
organization string
civil_number string
description string
is_staff boolean Designates whether the user can log into this admin site.
is_active boolean Designates whether this user should be treated as active. Unselect this instead of deleting accounts.
is_support boolean Designates whether the user is a global support user.
token string
token_lifetime integer Token lifetime in seconds.
token_expires_at string (date-time)
registration_method string Indicates what registration method was used.
date_joined string (date-time)
agreement_date string (date-time) Indicates when the user has agreed with the policy.
notifications_enabled boolean Designates whether the user is allowed to receive email notifications.
preferred_language string
permissions array of objects
permissions.user_uuid string (uuid)
permissions.user_name string
permissions.user_slug string
permissions.created string (date-time)
permissions.expiration_time string (date-time)
permissions.created_by_full_name string
permissions.created_by_username string
permissions.role_name string
permissions.role_description string
permissions.role_uuid string (uuid)
permissions.scope_type string
permissions.scope_uuid string (uuid)
permissions.scope_name string
permissions.customer_uuid string (uuid)
permissions.customer_name string
requested_email string
affiliations any Person's affiliation within organization such as student, faculty, staff.
first_name string
last_name string
birth_date string (date)
identity_provider_name string
identity_provider_label string
identity_provider_management_url string
identity_provider_fields array of strings
image string (uri)
identity_source string Indicates what identity provider was used.
has_active_session boolean
ip_address string
gender any ISO 5218 gender code
personal_title string Honorific title (Mr, Ms, Dr, Prof, etc.)
place_of_birth string
country_of_residence string
nationality string Primary citizenship (ISO 3166-1 alpha-2 code)
nationalities any List of all citizenships (ISO 3166-1 alpha-2 codes)
organization_country string
organization_type string SCHAC URN (e.g., urn:schac:homeOrganizationType:int:university)
organization_registry_code string Company registration code of the user's organization, if known
eduperson_assurance any REFEDS assurance profile URIs from identity provider
is_identity_manager boolean Designates whether the user is allowed to manage remote user identities.
attribute_sources any Per-attribute source and freshness tracking. Format: {'field_name': {'source': 'isd:', 'timestamp': 'ISO8601'}}.
managed_isds any List of ISD source identifiers this user can manage via Identity Bridge. E.g., ['isd:puhuri', 'isd:fenix']. Non-empty list implies identity manager role.
active_isds any List of ISDs that have asserted this user exists. User is deactivated when this becomes empty.

Synchronize user details from eduTEAMS

1
2
3
4
http \
  POST \
  https://api.example.com/api/users/a1b2c3d4-e5f6-7890-abcd-ef1234567890/pull_remote_user/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.users import users_pull_remote_user # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = users_pull_remote_user.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: users_pull_remote_user
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { usersPullRemoteUser } from 'waldur-js-client';

try {
  const response = await usersPullRemoteUser({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 - No response body

Recalculate user actions for a specific user

Staff-only action to trigger recalculation of user actions for a specific user.

1
2
3
4
http \
  POST \
  https://api.example.com/api/users/a1b2c3d4-e5f6-7890-abcd-ef1234567890/update_actions/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.update_actions_request import UpdateActionsRequest # (1)
from waldur_api_client.api.users import users_update_actions # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = UpdateActionsRequest()
response = users_update_actions.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: UpdateActionsRequest
  2. API Source: users_update_actions
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { usersUpdateActions } from 'waldur-js-client';

try {
  const response = await usersUpdateActions({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
provider_action_type string Optional provider action type to update. If not provided, updates all providers.

202 -

Field Type
status string
message string
provider_action_type string

Update

1
2
3
4
5
6
http \
  PUT \
  https://api.example.com/api/users/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  username="alice" \
  email="alice@example.com"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.user_request import UserRequest # (1)
from waldur_api_client.api.users import users_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = UserRequest(
    username="alice",
    email="alice@example.com"
)
response = users_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: UserRequest
  2. API Source: users_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { usersUpdate } from 'waldur-js-client';

try {
  const response = await usersUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "username": "alice",
    "email": "alice@example.com"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
username string ✓ Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
slug string URL-friendly identifier. Only editable by staff users.
native_name string
job_title string
email string (email) ✓
phone_number string
organization string
description string
is_staff boolean Designates whether the user can log into this admin site.
is_active boolean Designates whether this user should be treated as active. Unselect this instead of deleting accounts.
is_support boolean Designates whether the user is a global support user.
token_lifetime integer Token lifetime in seconds.
agree_with_policy boolean User must agree with the policy to register.
Constraints: write-only
notifications_enabled boolean Designates whether the user is allowed to receive email notifications.
preferred_language string
first_name string
last_name string
birth_date string (date)
image string (binary)
gender any ISO 5218 gender code
personal_title string Honorific title (Mr, Ms, Dr, Prof, etc.)
place_of_birth string
country_of_residence string
nationality string Primary citizenship (ISO 3166-1 alpha-2 code)
nationalities any List of all citizenships (ISO 3166-1 alpha-2 codes)
organization_country string
organization_type string SCHAC URN (e.g., urn:schac:homeOrganizationType:int:university)
organization_registry_code string Company registration code of the user's organization, if known
eduperson_assurance any REFEDS assurance profile URIs from identity provider
is_identity_manager boolean Designates whether the user is allowed to manage remote user identities.
managed_isds any List of ISD source identifiers this user can manage via Identity Bridge. E.g., ['isd:puhuri', 'isd:fenix']. Non-empty list implies identity manager role.

200 -

Field Type Description
url string (uri)
uuid string (uuid)
username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
slug string URL-friendly identifier. Only editable by staff users.
full_name string
native_name string
job_title string
email string (email)
phone_number string
organization string
civil_number string
description string
is_staff boolean Designates whether the user can log into this admin site.
is_active boolean Designates whether this user should be treated as active. Unselect this instead of deleting accounts.
is_support boolean Designates whether the user is a global support user.
token string
token_lifetime integer Token lifetime in seconds.
token_expires_at string (date-time)
registration_method string Indicates what registration method was used.
date_joined string (date-time)
agreement_date string (date-time) Indicates when the user has agreed with the policy.
notifications_enabled boolean Designates whether the user is allowed to receive email notifications.
preferred_language string
permissions array of objects
permissions.user_uuid string (uuid)
permissions.user_name string
permissions.user_slug string
permissions.created string (date-time)
permissions.expiration_time string (date-time)
permissions.created_by_full_name string
permissions.created_by_username string
permissions.role_name string
permissions.role_description string
permissions.role_uuid string (uuid)
permissions.scope_type string
permissions.scope_uuid string (uuid)
permissions.scope_name string
permissions.customer_uuid string (uuid)
permissions.customer_name string
requested_email string
affiliations any Person's affiliation within organization such as student, faculty, staff.
first_name string
last_name string
birth_date string (date)
identity_provider_name string
identity_provider_label string
identity_provider_management_url string
identity_provider_fields array of strings
image string (uri)
identity_source string Indicates what identity provider was used.
has_active_session boolean
ip_address string
gender any ISO 5218 gender code
personal_title string Honorific title (Mr, Ms, Dr, Prof, etc.)
place_of_birth string
country_of_residence string
nationality string Primary citizenship (ISO 3166-1 alpha-2 code)
nationalities any List of all citizenships (ISO 3166-1 alpha-2 codes)
organization_country string
organization_type string SCHAC URN (e.g., urn:schac:homeOrganizationType:int:university)
organization_registry_code string Company registration code of the user's organization, if known
eduperson_assurance any REFEDS assurance profile URIs from identity provider
is_identity_manager boolean Designates whether the user is allowed to manage remote user identities.
attribute_sources any Per-attribute source and freshness tracking. Format: {'field_name': {'source': 'isd:', 'timestamp': 'ISO8601'}}.
managed_isds any List of ISD source identifiers this user can manage via Identity Bridge. E.g., ['isd:puhuri', 'isd:fenix']. Non-empty list implies identity manager role.
active_isds any List of ISDs that have asserted this user exists. User is deactivated when this becomes empty.

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/users/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_user_request import PatchedUserRequest # (1)
from waldur_api_client.api.users import users_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedUserRequest()
response = users_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedUserRequest
  2. API Source: users_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { usersPartialUpdate } from 'waldur-js-client';

try {
  const response = await usersPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
slug string URL-friendly identifier. Only editable by staff users.
native_name string
job_title string
phone_number string
organization string
description string
is_staff boolean Designates whether the user can log into this admin site.
is_active boolean Designates whether this user should be treated as active. Unselect this instead of deleting accounts.
is_support boolean Designates whether the user is a global support user.
token_lifetime integer Token lifetime in seconds.
agree_with_policy boolean User must agree with the policy to register.
Constraints: write-only
notifications_enabled boolean Designates whether the user is allowed to receive email notifications.
preferred_language string
first_name string
last_name string
birth_date string (date)
image string (binary)
gender any ISO 5218 gender code
personal_title string Honorific title (Mr, Ms, Dr, Prof, etc.)
place_of_birth string
country_of_residence string
nationality string Primary citizenship (ISO 3166-1 alpha-2 code)
nationalities any List of all citizenships (ISO 3166-1 alpha-2 codes)
organization_country string
organization_type string SCHAC URN (e.g., urn:schac:homeOrganizationType:int:university)
organization_registry_code string Company registration code of the user's organization, if known
eduperson_assurance any REFEDS assurance profile URIs from identity provider
is_identity_manager boolean Designates whether the user is allowed to manage remote user identities.
managed_isds any List of ISD source identifiers this user can manage via Identity Bridge. E.g., ['isd:puhuri', 'isd:fenix']. Non-empty list implies identity manager role.

200 -

Field Type Description
url string (uri)
uuid string (uuid)
username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
slug string URL-friendly identifier. Only editable by staff users.
full_name string
native_name string
job_title string
email string (email)
phone_number string
organization string
civil_number string
description string
is_staff boolean Designates whether the user can log into this admin site.
is_active boolean Designates whether this user should be treated as active. Unselect this instead of deleting accounts.
is_support boolean Designates whether the user is a global support user.
token string
token_lifetime integer Token lifetime in seconds.
token_expires_at string (date-time)
registration_method string Indicates what registration method was used.
date_joined string (date-time)
agreement_date string (date-time) Indicates when the user has agreed with the policy.
notifications_enabled boolean Designates whether the user is allowed to receive email notifications.
preferred_language string
permissions array of objects
permissions.user_uuid string (uuid)
permissions.user_name string
permissions.user_slug string
permissions.created string (date-time)
permissions.expiration_time string (date-time)
permissions.created_by_full_name string
permissions.created_by_username string
permissions.role_name string
permissions.role_description string
permissions.role_uuid string (uuid)
permissions.scope_type string
permissions.scope_uuid string (uuid)
permissions.scope_name string
permissions.customer_uuid string (uuid)
permissions.customer_name string
requested_email string
affiliations any Person's affiliation within organization such as student, faculty, staff.
first_name string
last_name string
birth_date string (date)
identity_provider_name string
identity_provider_label string
identity_provider_management_url string
identity_provider_fields array of strings
image string (uri)
identity_source string Indicates what identity provider was used.
has_active_session boolean
ip_address string
gender any ISO 5218 gender code
personal_title string Honorific title (Mr, Ms, Dr, Prof, etc.)
place_of_birth string
country_of_residence string
nationality string Primary citizenship (ISO 3166-1 alpha-2 code)
nationalities any List of all citizenships (ISO 3166-1 alpha-2 codes)
organization_country string
organization_type string SCHAC URN (e.g., urn:schac:homeOrganizationType:int:university)
organization_registry_code string Company registration code of the user's organization, if known
eduperson_assurance any REFEDS assurance profile URIs from identity provider
is_identity_manager boolean Designates whether the user is allowed to manage remote user identities.
attribute_sources any Per-attribute source and freshness tracking. Format: {'field_name': {'source': 'isd:', 'timestamp': 'ISO8601'}}.
managed_isds any List of ISD source identifiers this user can manage via Identity Bridge. E.g., ['isd:puhuri', 'isd:fenix']. Non-empty list implies identity manager role.
active_isds any List of ISDs that have asserted this user exists. User is deactivated when this becomes empty.

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/users/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.users import users_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = users_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: users_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { usersDestroy } from 'waldur-js-client';

try {
  const response = await usersDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Other Actions

Get user data access history

Shows historical log of who has accessed the user's profile data. Regular users see anonymized accessor categories. Staff/support see full details including accessor identity, IP, and context.

1
2
3
4
http \
  GET \
  https://api.example.com/api/users/a1b2c3d4-e5f6-7890-abcd-ef1234567890/data_access_history/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.marketplace_service_provider_user_o_enum import MarketplaceServiceProviderUserOEnum # (1)
from waldur_api_client.api.users import users_data_access_history_list # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = users_data_access_history_list.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

for item in response:
    print(item)
  1. Model Source: MarketplaceServiceProviderUserOEnum
  2. API Source: users_data_access_history_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { usersDataAccessHistoryList } from 'waldur-js-client';

try {
  const response = await usersDataAccessHistoryList({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type Description
accessor_type string Filter by accessor type (staff, support, organization_member, self)
agreement_date string (date-time) Agreement date after
civil_number string
customer_uuid string (uuid) Customer UUID
date_joined string (date-time) Date joined after
description string
email string Email
end_date string (date) Filter logs until this date (inclusive)
full_name string Full name
is_active boolean Is active
is_staff boolean Is staff
is_support boolean Is support
job_title string Job title
modified string (date-time) Date modified after
native_name string Native name
o array Ordering
organization string Organization
organization_roles string Organization roles
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
phone_number string
project_roles string Project roles
project_uuid string (uuid) Project UUID
query string Filter by first name, last name, civil number, username or email
registration_method string
start_date string (date) Filter logs from this date (inclusive)
user_keyword string User keyword
username string Username (exact)
username_list string Comma-separated usernames

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid)
timestamp string (date-time)
accessor_type string
Enum: staff, support, organization_member, service_provider, self
accessed_fields array of strings
accessor_category string
accessor object
accessor.uuid string (uuid)
accessor.username string
accessor.full_name string
ip_address any An IPv4 or IPv6 address.
context object (free-form)

Get user data access visibility

Shows who has access to the user's profile data. Includes administrative access (staff/support), organizational access (same customer/project), and service provider access (via consent). Regular users see counts for admin access; staff/support see individual records.

1
2
3
4
http \
  GET \
  https://api.example.com/api/users/a1b2c3d4-e5f6-7890-abcd-ef1234567890/data_access/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.users import users_data_access_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = users_data_access_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: users_data_access_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { usersDataAccessRetrieve } from 'waldur-js-client';

try {
  const response = await usersDataAccessRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
administrative_access object
administrative_access.description string
administrative_access.staff_count integer
administrative_access.support_count integer
administrative_access.users array of objects
administrative_access.users.user_uuid string (uuid)
administrative_access.users.username string
administrative_access.users.full_name string
administrative_access.users.access_type string
organizational_access array of objects
organizational_access.scope_type string
organizational_access.scope_uuid string (uuid)
organizational_access.scope_name string
organizational_access.users array of objects
organizational_access.users.user_uuid string (uuid)
organizational_access.users.username string
organizational_access.users.full_name string
organizational_access.users.role string
service_provider_access array of objects
service_provider_access.offering_uuid string (uuid)
service_provider_access.offering_name string
service_provider_access.provider_name string
service_provider_access.provider_uuid string (uuid)
service_provider_access.exposed_fields array of strings
service_provider_access.consent_date string
service_provider_access.consent_version string
service_provider_access.provider_team array of objects
service_provider_access.provider_team.user_uuid string (uuid)
service_provider_access.provider_team.username string
service_provider_access.provider_team.full_name string
service_provider_access.provider_team.role string
summary object
summary.total_administrative_access integer
summary.total_organizational_access integer
summary.total_provider_access integer

Get object state at a specific timestamp

Returns the state of the object as it was at the specified timestamp. Only accessible by staff and support users.

1
2
3
4
5
http \
  GET \
  https://api.example.com/api/users/a1b2c3d4-e5f6-7890-abcd-ef1234567890/history/at/ \
  Authorization:"Token YOUR_API_TOKEN" \
  timestamp=="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.users import users_history_at_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = users_history_at_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    timestamp="string-value"
)

print(response)
  1. API Source: users_history_at_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { usersHistoryAtRetrieve } from 'waldur-js-client';

try {
  const response = await usersHistoryAtRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  query: {
    "timestamp": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type Required Description
timestamp string ✓ ISO 8601 timestamp to query the object state at

200 -

Field Type Description
id integer Version ID
revision_date string (date-time) When this revision was created
revision_user object (free-form) User who created this revision
revision_comment string Comment describing the revision
serialized_data object (free-form) Serialized model fields at this revision

400 -

404 -

Get version history

Returns the version history for this object. Only accessible by staff and support users.

1
2
3
4
http \
  GET \
  https://api.example.com/api/users/a1b2c3d4-e5f6-7890-abcd-ef1234567890/history/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.marketplace_service_provider_user_o_enum import MarketplaceServiceProviderUserOEnum # (1)
from waldur_api_client.api.users import users_history_list # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = users_history_list.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

for item in response:
    print(item)
  1. Model Source: MarketplaceServiceProviderUserOEnum
  2. API Source: users_history_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { usersHistoryList } from 'waldur-js-client';

try {
  const response = await usersHistoryList({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type Description
agreement_date string (date-time) Agreement date after
civil_number string
created_after string Filter versions created after this timestamp (ISO 8601)
created_before string Filter versions created before this timestamp (ISO 8601)
customer_uuid string (uuid) Customer UUID
date_joined string (date-time) Date joined after
description string
email string Email
full_name string Full name
is_active boolean Is active
is_staff boolean Is staff
is_support boolean Is support
job_title string Job title
modified string (date-time) Date modified after
native_name string Native name
o array Ordering
organization string Organization
organization_roles string Organization roles
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
phone_number string
project_roles string Project roles
project_uuid string (uuid) Project UUID
query string Filter by first name, last name, civil number, username or email
registration_method string
user_keyword string User keyword
username string Username (exact)
username_list string Comma-separated usernames

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
id integer Version ID
revision_date string (date-time) When this revision was created
revision_user object (free-form) User who created this revision
revision_comment string Comment describing the revision
serialized_data object (free-form) Serialized model fields at this revision

Get identity bridge status for a user

Returns diagnostic information about a user's identity bridge state: active ISDs, per-attribute source tracking with staleness detection, and effective bridge-writable fields. Staff only.

1
2
3
4
http \
  GET \
  https://api.example.com/api/users/a1b2c3d4-e5f6-7890-abcd-ef1234567890/identity_bridge_status/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.users import users_identity_bridge_status_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = users_identity_bridge_status_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: users_identity_bridge_status_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { usersIdentityBridgeStatusRetrieve } from 'waldur-js-client';

try {
  const response = await usersIdentityBridgeStatusRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
active_isds array of strings
managed_isds array of strings
attribute_sources object (free-form)
stale_attributes array of strings
effective_bridge_fields array of strings
is_federated boolean

Get current user details

Get current user details, including authentication token and profile completeness status.

1
2
3
4
http \
  GET \
  https://api.example.com/api/users/me/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.user_field_enum import UserFieldEnum # (1)
from waldur_api_client.api.users import users_me_retrieve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = users_me_retrieve.sync(client=client)

print(response)
  1. Model Source: UserFieldEnum
  2. API Source: users_me_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { usersMeRetrieve } from 'waldur-js-client';

try {
  const response = await usersMeRetrieve({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type
field array

200 -

Field Type Description
url string (uri)
uuid string (uuid)
username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
slug string URL-friendly identifier. Only editable by staff users.
full_name string
native_name string
job_title string
email string (email)
phone_number string
organization string
civil_number string
description string
is_staff boolean Designates whether the user can log into this admin site.
is_active boolean Designates whether this user should be treated as active. Unselect this instead of deleting accounts.
is_support boolean Designates whether the user is a global support user.
token string
token_lifetime integer Token lifetime in seconds.
token_expires_at string (date-time)
registration_method string Indicates what registration method was used.
date_joined string (date-time)
agreement_date string (date-time) Indicates when the user has agreed with the policy.
notifications_enabled boolean Designates whether the user is allowed to receive email notifications.
preferred_language string
permissions array of objects
permissions.user_uuid string (uuid)
permissions.user_name string
permissions.user_slug string
permissions.created string (date-time)
permissions.expiration_time string (date-time)
permissions.created_by_full_name string
permissions.created_by_username string
permissions.role_name string
permissions.role_description string
permissions.role_uuid string (uuid)
permissions.scope_type string
permissions.scope_uuid string (uuid)
permissions.scope_name string
permissions.customer_uuid string (uuid)
permissions.customer_name string
requested_email string
affiliations any Person's affiliation within organization such as student, faculty, staff.
first_name string
last_name string
birth_date string (date)
identity_provider_name string
identity_provider_label string
identity_provider_management_url string
identity_provider_fields array of strings
image string (uri)
identity_source string Indicates what identity provider was used.
has_active_session boolean
ip_address string
gender any ISO 5218 gender code
personal_title string Honorific title (Mr, Ms, Dr, Prof, etc.)
place_of_birth string
country_of_residence string
nationality string Primary citizenship (ISO 3166-1 alpha-2 code)
nationalities any List of all citizenships (ISO 3166-1 alpha-2 codes)
organization_country string
organization_type string SCHAC URN (e.g., urn:schac:homeOrganizationType:int:university)
organization_registry_code string Company registration code of the user's organization, if known
eduperson_assurance any REFEDS assurance profile URIs from identity provider
is_identity_manager boolean Designates whether the user is allowed to manage remote user identities.
attribute_sources any Per-attribute source and freshness tracking. Format: {'field_name': {'source': 'isd:', 'timestamp': 'ISO8601'}}.
managed_isds any List of ISD source identifiers this user can manage via Identity Bridge. E.g., ['isd:puhuri', 'isd:fenix']. Non-empty list implies identity manager role.
active_isds any List of ISDs that have asserted this user exists. User is deactivated when this becomes empty.

Check profile completeness

Check if user profile is complete with all mandatory attributes.

1
2
3
4
http \
  GET \
  https://api.example.com/api/users/profile_completeness/ \
  Authorization:"Token YOUR_API_TOKEN"

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.users import users_profile_completeness_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = users_profile_completeness_retrieve.sync(client=client)

print(response)
  1. API Source: users_profile_completeness_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { usersProfileCompletenessRetrieve } from 'waldur-js-client';

try {
  const response = await usersProfileCompletenessRetrieve({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

200 -

Field Type Description
is_complete boolean Whether all mandatory profile fields are filled.
missing_fields array of strings List of mandatory fields that are missing.
mandatory_fields array of strings List of all mandatory fields.
enforcement_enabled boolean Whether enforcement of mandatory attributes is enabled.

Get user auth token

1
2
3
4
http \
  GET \
  https://api.example.com/api/users/a1b2c3d4-e5f6-7890-abcd-ef1234567890/token/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.users import users_token_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = users_token_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: users_token_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { usersTokenRetrieve } from 'waldur-js-client';

try {
  const response = await usersTokenRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
created string (date-time)
user_first_name string
user_last_name string
user_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
user_is_active boolean Designates whether this user should be treated as active. Unselect this instead of deleting accounts.
user_token_lifetime integer Token lifetime in seconds.
token string

Get user counts by active status

Returns aggregated counts of users by active/inactive status. Staff or support only.

1
2
3
4
http \
  GET \
  https://api.example.com/api/users/user_active_status_count/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.marketplace_service_provider_user_o_enum import MarketplaceServiceProviderUserOEnum # (1)
from waldur_api_client.api.users import users_user_active_status_count_list # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = users_user_active_status_count_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: MarketplaceServiceProviderUserOEnum
  2. API Source: users_user_active_status_count_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { usersUserActiveStatusCountList } from 'waldur-js-client';

try {
  const response = await usersUserActiveStatusCountList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
agreement_date string (date-time) Agreement date after
civil_number string
customer_uuid string (uuid) Customer UUID
date_joined string (date-time) Date joined after
description string
email string Email
full_name string Full name
is_active boolean Is active
is_staff boolean Is staff
is_support boolean Is support
job_title string Job title
modified string (date-time) Date modified after
native_name string Native name
o array Ordering
organization string Organization
organization_roles string Organization roles
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
phone_number string
project_roles string Project roles
project_uuid string (uuid) Project UUID
query string Filter by first name, last name, civil number, username or email
registration_method string
user_keyword string User keyword
username string Username (exact)
username_list string Comma-separated usernames

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
status string
count integer

Get user counts by preferred language

Returns aggregated counts of users by preferred language. Staff or support only.

1
2
3
4
http \
  GET \
  https://api.example.com/api/users/user_language_count/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.marketplace_service_provider_user_o_enum import MarketplaceServiceProviderUserOEnum # (1)
from waldur_api_client.api.users import users_user_language_count_list # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = users_user_language_count_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: MarketplaceServiceProviderUserOEnum
  2. API Source: users_user_language_count_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { usersUserLanguageCountList } from 'waldur-js-client';

try {
  const response = await usersUserLanguageCountList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
agreement_date string (date-time) Agreement date after
civil_number string
customer_uuid string (uuid) Customer UUID
date_joined string (date-time) Date joined after
description string
email string Email
full_name string Full name
is_active boolean Is active
is_staff boolean Is staff
is_support boolean Is support
job_title string Job title
modified string (date-time) Date modified after
native_name string Native name
o array Ordering
organization string Organization
organization_roles string Organization roles
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
phone_number string
project_roles string Project roles
project_uuid string (uuid) Project UUID
query string Filter by first name, last name, civil number, username or email
registration_method string
user_keyword string User keyword
username string Username (exact)
username_list string Comma-separated usernames

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
language string
count integer

Returns user registration counts aggregated by month. Staff or support only.

1
2
3
4
http \
  GET \
  https://api.example.com/api/users/user_registration_trend/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.marketplace_service_provider_user_o_enum import MarketplaceServiceProviderUserOEnum # (1)
from waldur_api_client.api.users import users_user_registration_trend_list # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = users_user_registration_trend_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: MarketplaceServiceProviderUserOEnum
  2. API Source: users_user_registration_trend_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { usersUserRegistrationTrendList } from 'waldur-js-client';

try {
  const response = await usersUserRegistrationTrendList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
agreement_date string (date-time) Agreement date after
civil_number string
customer_uuid string (uuid) Customer UUID
date_joined string (date-time) Date joined after
description string
email string Email
full_name string Full name
is_active boolean Is active
is_staff boolean Is staff
is_support boolean Is support
job_title string Job title
modified string (date-time) Date modified after
native_name string Native name
o array Ordering
organization string Organization
organization_roles string Organization roles
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
phone_number string
project_roles string Project roles
project_uuid string (uuid) Project UUID
query string Filter by first name, last name, civil number, username or email
registration_method string
user_keyword string User keyword
username string Username (exact)
username_list string Comma-separated usernames

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
month string
count integer

Cancel email change request

Cancel email update request

1
2
3
4
http \
  POST \
  https://api.example.com/api/users/a1b2c3d4-e5f6-7890-abcd-ef1234567890/cancel_change_email/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.users import users_cancel_change_email # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = users_cancel_change_email.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: users_cancel_change_email
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { usersCancelChangeEmail } from 'waldur-js-client';

try {
  const response = await usersCancelChangeEmail({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 - No response body

Request email change

Allows to change email for user.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/users/a1b2c3d4-e5f6-7890-abcd-ef1234567890/change_email/ \
  Authorization:"Token YOUR_API_TOKEN" \
  email="alice@example.com"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.user_email_change_request import UserEmailChangeRequest # (1)
from waldur_api_client.api.users import users_change_email # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = UserEmailChangeRequest(
    email="alice@example.com"
)
response = users_change_email.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: UserEmailChangeRequest
  2. API Source: users_change_email
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { usersChangeEmail } from 'waldur-js-client';

try {
  const response = await usersChangeEmail({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "email": "alice@example.com"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
email string (email) ✓

200 - No response body

Change user password

Allows staff user to change password for any user.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/users/a1b2c3d4-e5f6-7890-abcd-ef1234567890/change_password/ \
  Authorization:"Token YOUR_API_TOKEN" \
  new_password="********"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.password_change_request import PasswordChangeRequest # (1)
from waldur_api_client.api.users import users_change_password # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PasswordChangeRequest(
    new_password="********"
)
response = users_change_password.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PasswordChangeRequest
  2. API Source: users_change_password
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { usersChangePassword } from 'waldur-js-client';

try {
  const response = await usersChangePassword({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "new_password": "********"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
new_password string ✓

200 - No response body

Confirm email change

Confirm email update using code

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/users/confirm_email/ \
  Authorization:"Token YOUR_API_TOKEN" \
  code="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.confirm_email_request_request import ConfirmEmailRequestRequest # (1)
from waldur_api_client.api.users import users_confirm_email # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ConfirmEmailRequestRequest(
    code="string-value"
)
response = users_confirm_email.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ConfirmEmailRequestRequest
  2. API Source: users_confirm_email
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { usersConfirmEmail } from 'waldur-js-client';

try {
  const response = await usersConfirmEmail({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "code": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required
code string ✓

200 - No response body

Refresh user auth token

1
2
3
4
http \
  POST \
  https://api.example.com/api/users/a1b2c3d4-e5f6-7890-abcd-ef1234567890/refresh_token/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.users import users_refresh_token # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = users_refresh_token.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: users_refresh_token
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { usersRefreshToken } from 'waldur-js-client';

try {
  const response = await usersRefreshToken({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
created string (date-time)
user_first_name string
user_last_name string
user_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
user_is_active boolean Designates whether this user should be treated as active. Unselect this instead of deleting accounts.
user_token_lifetime integer Token lifetime in seconds.
token string

Trigger SCIM synchronization for all users

Staff-only action to queue SCIM synchronization for all users.

1
2
3
4
http \
  POST \
  https://api.example.com/api/users/scim_sync_all/ \
  Authorization:"Token YOUR_API_TOKEN"

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.users import users_scim_sync_all # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = users_scim_sync_all.sync(client=client)

print(response)
  1. API Source: users_scim_sync_all
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { usersScimSyncAll } from 'waldur-js-client';

try {
  const response = await usersScimSyncAll({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

200 -

Field Type
detail string

Send action notification to a specific user

Staff-only action to send a pending actions digest notification to a specific user.

1
2
3
4
http \
  POST \
  https://api.example.com/api/users/a1b2c3d4-e5f6-7890-abcd-ef1234567890/send_notification/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.users import users_send_notification # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = users_send_notification.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: users_send_notification
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { usersSendNotification } from 'waldur-js-client';

try {
  const response = await usersSendNotification({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

202 -

Field Type
status string
message string

System configuration

Celery Stats

Operations Summary

Method Endpoint Description
GET /api/celery-stats/ Get Celery worker statistics

Get Celery worker statistics

Provides a comprehensive snapshot of all Celery workers' status.

This endpoint returns detailed information about: - active: Tasks currently being executed by workers - scheduled: Tasks scheduled for future execution (with ETA) - reserved: Tasks received by workers but not yet started - revoked: Task IDs that have been cancelled/revoked - query_task: Results of task queries (if any) - stats: Detailed worker statistics including uptime, pool info, and broker connection

Each field is a dictionary where keys are worker names (e.g., 'celery@hostname'). If no workers are available, fields will be null.

Requires support user permissions.

1
2
3
4
http \
  GET \
  https://api.example.com/api/celery-stats/ \
  Authorization:"Token YOUR_API_TOKEN"

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.celery_stats import celery_stats_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = celery_stats_retrieve.sync(client=client)

print(response)
  1. API Source: celery_stats_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { celeryStatsRetrieve } from 'waldur-js-client';

try {
  const response = await celeryStatsRetrieve({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

200 -

Field Type Description
active object (free-form) Currently executing tasks per worker. Keys are worker names, values are lists of active tasks.
scheduled object (free-form) Tasks scheduled for future execution per worker. Keys are worker names, values are lists of scheduled tasks with ETA.
reserved object (free-form) Tasks that have been received but not yet started per worker. Keys are worker names, values are lists of reserved tasks.
revoked object (free-form) IDs of revoked (cancelled) tasks per worker. Keys are worker names, values are lists of task IDs.
query_task object (free-form) Query results for specific tasks. May be null if no query was performed.
stats object (free-form) Detailed statistics per worker including uptime, pool info, and resource usage. Keys are worker names.

Configuration

Operations Summary

Method Endpoint Description
GET /api/configuration/ Get public configuration

Get public configuration

Returns a dictionary of public settings for the Waldur deployment. This includes feature flags, authentication methods, and other configuration details that are safe to expose to any user.

1
2
3
4
http \
  GET \
  https://api.example.com/api/configuration/ \
  Authorization:"Token YOUR_API_TOKEN"

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.configuration import configuration_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = configuration_retrieve.sync(client=client)

print(response)
  1. API Source: configuration_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { configurationRetrieve } from 'waldur-js-client';

try {
  const response = await configurationRetrieve({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

200 -

Database Stats

Operations Summary

Method Endpoint Description
GET /api/database-stats/ Get comprehensive database statistics

Get comprehensive database statistics

Retrieves comprehensive statistics about the PostgreSQL database including: - Table statistics: Top 10 largest tables by size - Connection statistics: Active, idle, and waiting connections with utilization - Database size: Total size, data size, and index size - Cache performance: Buffer cache and index hit ratios (should be >99%) - Transaction statistics: Commits, rollbacks, deadlocks - Lock statistics: Current locks and waiting queries - Maintenance statistics: Dead tuples, vacuum needs, oldest transaction age - Active queries: Currently running queries with duration - Query performance: Sequential vs index scan ratios - Replication status: WAL size and replication lag (if applicable)

This information is useful for monitoring, debugging, and performance tuning. Requires support user permissions.

1
2
3
4
http \
  GET \
  https://api.example.com/api/database-stats/ \
  Authorization:"Token YOUR_API_TOKEN"

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.database_stats import database_stats_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = database_stats_retrieve.sync(client=client)

print(response)
  1. API Source: database_stats_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { databaseStatsRetrieve } from 'waldur-js-client';

try {
  const response = await databaseStatsRetrieve({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

200 -

Field Type Description
table_stats array of objects Top largest tables by size
table_stats.table_name string Name of the database table
table_stats.total_size integer Total size of the table in bytes
table_stats.data_size integer Size of the actual data in bytes
table_stats.external_size integer Size of external data (e.g., TOAST) in bytes
connections any Connection statistics
database_size any Database size information
cache_performance any Cache hit ratios and memory settings
transactions any Transaction commit/rollback statistics
locks any Current lock statistics
maintenance any Vacuum and maintenance statistics
active_queries any Currently running queries
query_performance any Query performance indicators
replication any Replication status (if applicable)

Debug

Operations Summary

Method Endpoint Description
GET /api/debug/pubsub/circuit_breaker/ Get circuit breaker state
GET /api/debug/pubsub/dead_letter_queue/ Get dead letter queue status
GET /api/debug/pubsub/message_state_cache/ Get message state cache statistics
GET /api/debug/pubsub/metrics/ Get publishing metrics
GET /api/debug/pubsub/overview/ Get pubsub system health overview
GET /api/debug/pubsub/queues/ Get subscription queues overview
POST /api/debug/pubsub/circuit_breaker_reset/ Reset circuit breaker
POST /api/debug/pubsub/metrics_reset/ Reset publishing metrics

Get circuit breaker state

Get current STOMP circuit breaker state and statistics.

Returns: - state: Current state (closed/open/half_open) - failure_count: Number of consecutive failures - success_count: Successes since last state change - last_failure_time: Timestamp of last failure - last_state_change: When state last changed - config: Circuit breaker configuration - state_history: Recent state transitions

Requires staff permissions.

1
2
3
4
http \
  GET \
  https://api.example.com/api/debug/pubsub/circuit_breaker/ \
  Authorization:"Token YOUR_API_TOKEN"

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.debug import debug_pubsub_circuit_breaker_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = debug_pubsub_circuit_breaker_retrieve.sync(client=client)

print(response)
  1. API Source: debug_pubsub_circuit_breaker_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { debugPubsubCircuitBreakerRetrieve } from 'waldur-js-client';

try {
  const response = await debugPubsubCircuitBreakerRetrieve({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

200 -

Field Type Description
state string Current state: closed, open, or half_open
failure_count integer Number of consecutive failures
success_count integer Successful calls since last state change
last_failure_time number (double) Unix timestamp of last failure
last_state_change number (double) Unix timestamp of last state change
config any Circuit breaker configuration
state_history array of objects Recent state transitions (last 50)
state_history.timestamp number (double) Unix timestamp of state change
state_history.from_state string Previous state
state_history.to_state string New state
state_history.reason string Reason for state change

Get dead letter queue status

Get dead letter queue (DLQ) statistics.

The DLQ receives messages that failed to be delivered to their original destination. This endpoint shows the current DLQ status.

Note: DLQ is configured per-vhost. This endpoint checks all vhosts for queues with 'dlq' in the name.

Requires staff permissions.

1
2
3
4
http \
  GET \
  https://api.example.com/api/debug/pubsub/dead_letter_queue/ \
  Authorization:"Token YOUR_API_TOKEN"

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.debug import debug_pubsub_dead_letter_queue_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = debug_pubsub_dead_letter_queue_retrieve.sync(client=client)

print(response)
  1. API Source: debug_pubsub_dead_letter_queue_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { debugPubsubDeadLetterQueueRetrieve } from 'waldur-js-client';

try {
  const response = await debugPubsubDeadLetterQueueRetrieve({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

200 -

Field Type Description
total_dlq_messages integer Total messages across all DLQs
dlq_count integer Number of DLQ queues found
dlq_queues array of objects List of DLQ queues with their statistics
dlq_queues.vhost string Virtual host name
dlq_queues.queue_name string DLQ queue name
dlq_queues.messages integer Total messages in DLQ
dlq_queues.messages_ready integer Messages ready for delivery
dlq_queues.consumers integer Number of consumers attached
note string Informational note about DLQs

503 -

Field Type Description
error string Error message describing what went wrong

Get message state cache statistics

Get message state tracker cache statistics for idempotency.

The message state tracker prevents duplicate message sends by caching the hash of message content. This endpoint provides cache statistics.

Query params: - resource_uuid: Filter by specific resource - message_type: Filter by message type

Requires staff permissions.

1
2
3
4
http \
  GET \
  https://api.example.com/api/debug/pubsub/message_state_cache/ \
  Authorization:"Token YOUR_API_TOKEN"

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.debug import debug_pubsub_message_state_cache_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = debug_pubsub_message_state_cache_retrieve.sync(client=client)

print(response)
  1. API Source: debug_pubsub_message_state_cache_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { debugPubsubMessageStateCacheRetrieve } from 'waldur-js-client';

try {
  const response = await debugPubsubMessageStateCacheRetrieve({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

200 -

Field Type Description
cache_ttl integer Cache TTL in seconds
description string Cache description
filter any Applied filters

Get publishing metrics

Get message publishing metrics and statistics.

Returns: - messages_sent: Total messages successfully sent - messages_failed: Total failed message attempts - messages_retried: Messages that required retry - messages_skipped: Messages skipped due to circuit breaker - circuit_breaker_trips: Number of times circuit opened - rate_limiter_rejections: Messages rejected by rate limiter - avg_publish_time_ms: Average publish latency - last_publish_time: Timestamp of last publish attempt

Requires staff permissions.

1
2
3
4
http \
  GET \
  https://api.example.com/api/debug/pubsub/metrics/ \
  Authorization:"Token YOUR_API_TOKEN"

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.debug import debug_pubsub_metrics_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = debug_pubsub_metrics_retrieve.sync(client=client)

print(response)
  1. API Source: debug_pubsub_metrics_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { debugPubsubMetricsRetrieve } from 'waldur-js-client';

try {
  const response = await debugPubsubMetricsRetrieve({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

200 -

Field Type Description
messages_sent integer Total messages successfully sent
messages_failed integer Total failed message attempts
messages_retried integer Messages that required retry
messages_skipped integer Messages skipped due to circuit breaker
circuit_breaker_trips integer Number of times circuit breaker opened
rate_limiter_rejections integer Messages rejected by rate limiter
avg_publish_time_ms number (double) Average message publish latency in milliseconds
last_publish_time number (double) Unix timestamp of last publish attempt

Get pubsub system health overview

Dashboard overview of pubsub system health.

Combines circuit breaker state, publishing metrics, and health indicators into a single response suitable for monitoring dashboards.

Requires staff permissions.

1
2
3
4
http \
  GET \
  https://api.example.com/api/debug/pubsub/overview/ \
  Authorization:"Token YOUR_API_TOKEN"

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.debug import debug_pubsub_overview_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = debug_pubsub_overview_retrieve.sync(client=client)

print(response)
  1. API Source: debug_pubsub_overview_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { debugPubsubOverviewRetrieve } from 'waldur-js-client';

try {
  const response = await debugPubsubOverviewRetrieve({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

200 -

Field Type Description
health_status string Overall health: healthy, degraded, or critical
issues array of strings List of current issues affecting health
circuit_breaker any Circuit breaker summary
metrics any Publishing metrics summary
last_updated string (date-time) Timestamp when overview was generated

Get subscription queues overview

Get overview of subscription queues from RabbitMQ.

Returns summary of subscription queues across all vhosts including message counts and queue statistics.

Note: For detailed queue management, use /api/rabbitmq-stats/ endpoint.

Requires staff permissions.

1
2
3
4
http \
  GET \
  https://api.example.com/api/debug/pubsub/queues/ \
  Authorization:"Token YOUR_API_TOKEN"

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.debug import debug_pubsub_queues_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = debug_pubsub_queues_retrieve.sync(client=client)

print(response)
  1. API Source: debug_pubsub_queues_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { debugPubsubQueuesRetrieve } from 'waldur-js-client';

try {
  const response = await debugPubsubQueuesRetrieve({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

200 -

Field Type Description
total_vhosts integer Total number of vhosts with subscription queues
total_queues integer Total number of subscription queues
total_messages integer Total messages across all subscription queues
top_queues_by_messages array of objects Top 10 queues by message count
top_queues_by_messages.vhost string Virtual host name
top_queues_by_messages.name string Queue name
top_queues_by_messages.messages integer Number of messages in queue
top_queues_by_messages.consumers integer Number of consumers attached

503 -

Field Type Description
error string Error message describing what went wrong

Reset circuit breaker

Manually reset the STOMP circuit breaker to CLOSED state.

Use with caution - only when RabbitMQ is confirmed healthy.

Requires staff permissions.

1
2
3
4
http \
  POST \
  https://api.example.com/api/debug/pubsub/circuit_breaker_reset/ \
  Authorization:"Token YOUR_API_TOKEN"

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.debug import debug_pubsub_circuit_breaker_reset # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = debug_pubsub_circuit_breaker_reset.sync(client=client)

print(response)
  1. API Source: debug_pubsub_circuit_breaker_reset
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { debugPubsubCircuitBreakerReset } from 'waldur-js-client';

try {
  const response = await debugPubsubCircuitBreakerReset({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

200 -

Field Type Description
status string Operation status
state string New circuit breaker state after reset

Reset publishing metrics

Reset all publishing metrics counters to zero.

Requires staff permissions.

1
2
3
4
http \
  POST \
  https://api.example.com/api/debug/pubsub/metrics_reset/ \
  Authorization:"Token YOUR_API_TOKEN"

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.debug import debug_pubsub_metrics_reset # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = debug_pubsub_metrics_reset.sync(client=client)

print(response)
  1. API Source: debug_pubsub_metrics_reset
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { debugPubsubMetricsReset } from 'waldur-js-client';

try {
  const response = await debugPubsubMetricsReset({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

200 -

Field Type Description
status string Operation status

External Links

Method Endpoint Description
GET /api/external-links/ List external links
GET /api/external-links/{uuid}/ Retrieve external link
POST /api/external-links/ Create an external link
PUT /api/external-links/{uuid}/ Update an external link
PATCH /api/external-links/{uuid}/ Partially update an external link
DELETE /api/external-links/{uuid}/ Delete an external link

Retrieve a list of external links available in the system.

1
2
3
4
http \
  GET \
  https://api.example.com/api/external-links/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.external_links import external_links_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = external_links_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: external_links_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { externalLinksList } from 'waldur-js-client';

try {
  const response = await externalLinksList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
o string Which field to use when ordering the results.
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
query string Filter by name, link or description

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
url string (uri)
uuid string (uuid)
name string
description string
link string (uri)
image string (uri)
created string (date-time)
modified string (date-time)

Fetch the details of a specific external link by its UUID.

1
2
3
4
http \
  GET \
  https://api.example.com/api/external-links/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.external_links import external_links_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = external_links_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: external_links_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { externalLinksRetrieve } from 'waldur-js-client';

try {
  const response = await externalLinksRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
url string (uri)
uuid string (uuid)
name string
description string
link string (uri)
image string (uri)
created string (date-time)
modified string (date-time)

Create a new external link. This action is restricted to staff users.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/external-links/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-external-link" \
  link="https://api.example.com/api/link/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.external_link_request import ExternalLinkRequest # (1)
from waldur_api_client.api.external_links import external_links_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ExternalLinkRequest(
    name="my-awesome-external-link",
    link="https://api.example.com/api/link/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = external_links_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ExternalLinkRequest
  2. API Source: external_links_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { externalLinksCreate } from 'waldur-js-client';

try {
  const response = await externalLinksCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "name": "my-awesome-external-link",
    "link": "https://api.example.com/api/link/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required
name string ✓
description string
link string (uri) ✓
image string (binary)

201 -

Field Type
url string (uri)
uuid string (uuid)
name string
description string
link string (uri)
image string (uri)
created string (date-time)
modified string (date-time)

Update an existing external link. This action is restricted to staff users.

1
2
3
4
5
6
http \
  PUT \
  https://api.example.com/api/external-links/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-external-link" \
  link="https://api.example.com/api/link/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.external_link_request import ExternalLinkRequest # (1)
from waldur_api_client.api.external_links import external_links_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ExternalLinkRequest(
    name="my-awesome-external-link",
    link="https://api.example.com/api/link/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = external_links_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ExternalLinkRequest
  2. API Source: external_links_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { externalLinksUpdate } from 'waldur-js-client';

try {
  const response = await externalLinksUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-external-link",
    "link": "https://api.example.com/api/link/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
name string ✓
description string
link string (uri) ✓
image string (binary)

200 -

Field Type
url string (uri)
uuid string (uuid)
name string
description string
link string (uri)
image string (uri)
created string (date-time)
modified string (date-time)

Partially update an existing external link. This action is restricted to staff users.

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/external-links/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_external_link_request import PatchedExternalLinkRequest # (1)
from waldur_api_client.api.external_links import external_links_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedExternalLinkRequest()
response = external_links_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedExternalLinkRequest
  2. API Source: external_links_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { externalLinksPartialUpdate } from 'waldur-js-client';

try {
  const response = await externalLinksPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
name string
description string
link string (uri)
image string (binary)

200 -

Field Type
url string (uri)
uuid string (uuid)
name string
description string
link string (uri)
image string (uri)
created string (date-time)
modified string (date-time)

Delete an existing external link. This action is restricted to staff users.

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/external-links/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.external_links import external_links_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = external_links_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: external_links_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { externalLinksDestroy } from 'waldur-js-client';

try {
  const response = await externalLinksDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Feature Values

Operations Summary

Method Endpoint Description
POST /api/feature-values/ Update feature flags

Update feature flags

Allows administrators to enable or disable specific feature flags in the system. The request should be a dictionary where keys are feature sections and values are dictionaries of feature keys and their boolean state.

1
2
3
4
http \
  POST \
  https://api.example.com/api/feature-values/ \
  Authorization:"Token YOUR_API_TOKEN"

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.feature_values import feature_values # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = feature_values.sync(client=client)

print(response)
  1. API Source: feature_values
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { featureValues } from 'waldur-js-client';

try {
  const response = await featureValues({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

200 -

Media

Operations Summary

Method Endpoint Description
GET /api/media/{uuid}/ Get media file

Get media file

Get media file

1
2
3
4
http \
  GET \
  https://api.example.com/api/media/string-value/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.media import media_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = media_retrieve.sync(
    uuid="string-value",
    client=client
)

print(response)
  1. API Source: media_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { mediaRetrieve } from 'waldur-js-client';

try {
  const response = await mediaRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string ✓

200 -

Metadata

Operations Summary

Method Endpoint Description
GET /api/metadata/events/ Get event metadata
GET /api/metadata/features/ Get feature flag metadata
GET /api/metadata/permissions/ Get permission metadata
GET /api/metadata/settings/ Get overridable settings metadata

Get event metadata

Retrieves metadata for all available event types, grouped by categories. This endpoint is publicly accessible and is useful for building UIs for event filtering or webhook configuration.

1
2
3
4
http \
  GET \
  https://api.example.com/api/metadata/events/ \
  Authorization:"Token YOUR_API_TOKEN"

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.metadata import metadata_events_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = metadata_events_retrieve.sync(client=client)

print(response)
  1. API Source: metadata_events_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { metadataEventsRetrieve } from 'waldur-js-client';

try {
  const response = await metadataEventsRetrieve({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

200 -

Field Type Description
event_groups object (free-form) Map of event group keys to lists of event type enums from EventType

Get feature flag metadata

Retrieves metadata for all available feature flags, including their keys, descriptions, and grouping sections. This endpoint is publicly accessible and helps UIs to dynamically render feature-related settings.

1
2
3
4
http \
  GET \
  https://api.example.com/api/metadata/features/ \
  Authorization:"Token YOUR_API_TOKEN"

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.metadata import metadata_features_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = metadata_features_retrieve.sync(client=client)

print(response)
  1. API Source: metadata_features_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { metadataFeaturesRetrieve } from 'waldur-js-client';

try {
  const response = await metadataFeaturesRetrieve({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

200 -

Field Type Description
features array of objects List of feature sections with descriptions
feature_enums object (free-form) Nested feature enum values by section

Get permission metadata

Retrieves metadata about roles, permissions, and their descriptions. This endpoint is publicly accessible and provides data needed for UI components, such as role selection dropdowns and permission management interfaces.

1
2
3
4
http \
  GET \
  https://api.example.com/api/metadata/permissions/ \
  Authorization:"Token YOUR_API_TOKEN"

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.metadata import metadata_permissions_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = metadata_permissions_retrieve.sync(client=client)

print(response)
  1. API Source: metadata_permissions_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { metadataPermissionsRetrieve } from 'waldur-js-client';

try {
  const response = await metadataPermissionsRetrieve({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

200 -

Field Type Description
roles object (free-form) Map of role keys to role enum values from RoleEnum
permissions object (free-form) Map of permission keys to permission enum values from PermissionEnum
permission_map object (free-form) Map of resource types to create permission enums
permission_descriptions array of objects Grouped permission descriptions for UI

Get overridable settings metadata

Retrieves metadata for all settings that can be configured via the Constance backend. This includes setting keys, human-readable descriptions, default values, and types. This endpoint is publicly accessible.

1
2
3
4
http \
  GET \
  https://api.example.com/api/metadata/settings/ \
  Authorization:"Token YOUR_API_TOKEN"

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.metadata import metadata_settings_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = metadata_settings_retrieve.sync(client=client)

print(response)
  1. API Source: metadata_settings_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { metadataSettingsRetrieve } from 'waldur-js-client';

try {
  const response = await metadataSettingsRetrieve({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

200 -

Field Type Description
settings array of objects List of settings sections with configuration items

Override Settings

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/override-settings/ Get all overridable settings
Other Actions
POST /api/override-settings/ Update overridable settings

Core CRUD

Get all overridable settings

Returns all settings that can be overridden in the database via the Constance backend. Requires admin permissions.

1
2
3
4
http \
  GET \
  https://api.example.com/api/override-settings/ \
  Authorization:"Token YOUR_API_TOKEN"

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.override_settings import override_settings_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = override_settings_retrieve.sync(client=client)

print(response)
  1. API Source: override_settings_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { overrideSettingsRetrieve } from 'waldur-js-client';

try {
  const response = await overrideSettingsRetrieve({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

200 -

Field Type
SITE_NAME string
SITE_DESCRIPTION string
HOMEPORT_URL string
RANCHER_USERNAME_INPUT_LABEL string
DISCLAIMER_AREA_TEXT string
SITE_ADDRESS string
SITE_EMAIL string
SITE_PHONE string
CURRENCY_NAME string
THUMBNAIL_SIZE string
ANONYMOUS_USER_CAN_VIEW_OFFERINGS boolean
ANONYMOUS_USER_CAN_VIEW_PLANS boolean
RESTRICTED_OFFERING_VISIBILITY_MODE string
ALLOW_SERVICE_PROVIDER_OFFERING_MANAGEMENT boolean
NOTIFY_STAFF_ABOUT_APPROVALS boolean
NOTIFY_ABOUT_RESOURCE_CHANGE boolean
DISABLE_SENDING_NOTIFICATIONS_ABOUT_RESOURCE_UPDATE boolean
MARKETPLACE_LANDING_PAGE string
ENABLE_STALE_RESOURCE_NOTIFICATIONS boolean
TELEMETRY_URL string
TELEMETRY_VERSION integer
SCRIPT_RUN_MODE string
DOCKER_CLIENT string
DOCKER_RUN_OPTIONS string
DOCKER_SCRIPT_DIR string
DOCKER_REMOVE_CONTAINER boolean
DOCKER_IMAGES string
DOCKER_VOLUME_NAME string
K8S_NAMESPACE string
K8S_CONFIG_PATH string
K8S_JOB_TIMEOUT integer
ENABLE_STRICT_CHECK_ACCEPTING_INVITATION boolean
INVITATION_DISABLE_MULTIPLE_ROLES boolean
DEFAULT_IDP any
DOCS_URL string (uri)
SHORT_PAGE_TITLE string
FULL_PAGE_TITLE string
PROJECT_END_DATE_MANDATORY boolean
ENABLE_ORDER_START_DATE boolean
BRAND_COLOR string
HERO_LINK_LABEL string
HERO_LINK_URL string (uri)
SUPPORT_PORTAL_URL string (uri)
COMMON_FOOTER_TEXT string
COMMON_FOOTER_HTML string
LANGUAGE_CHOICES string
DISABLE_DARK_THEME boolean
POWERED_BY_LOGO string (uri)
HERO_IMAGE string (uri)
MARKETPLACE_HERO_IMAGE string (uri)
CALL_MANAGEMENT_HERO_IMAGE string (uri)
SIDEBAR_LOGO string (uri)
SIDEBAR_LOGO_DARK string (uri)
SIDEBAR_LOGO_MOBILE string (uri)
SIDEBAR_STYLE string
FONT_FAMILY string
LOGIN_LOGO string (uri)
LOGIN_LOGO_MULTILINGUAL object (free-form)
LOGIN_PAGE_LAYOUT string
LOGIN_PAGE_VIDEO_URL string (uri)
LOGIN_PAGE_STATS array of anys
LOGIN_PAGE_CAROUSEL_SLIDES array of anys
LOGIN_PAGE_NEWS array of anys
FAVICON string (uri)
OFFERING_LOGO_PLACEHOLDER string (uri)
DISCLAIMER_AREA_LOGO string (uri)
WALDUR_SUPPORT_ENABLED boolean
WALDUR_SUPPORT_ACTIVE_BACKEND_TYPE string
WALDUR_SUPPORT_DISPLAY_REQUEST_TYPE boolean
ATLASSIAN_MAP_WALDUR_USERS_TO_SERVICEDESK_AGENTS boolean
ATLASSIAN_API_URL string (uri)
ATLASSIAN_USERNAME string
ATLASSIAN_PASSWORD string
ATLASSIAN_EMAIL string (email)
ATLASSIAN_USE_OLD_API boolean
ATLASSIAN_TOKEN string
ATLASSIAN_PERSONAL_ACCESS_TOKEN string
ATLASSIAN_OAUTH2_CLIENT_ID string
ATLASSIAN_OAUTH2_ACCESS_TOKEN string
ATLASSIAN_OAUTH2_TOKEN_TYPE string
ATLASSIAN_VERIFY_SSL boolean
ATLASSIAN_PROJECT_ID string
ATLASSIAN_SHARED_USERNAME boolean
ATLASSIAN_CUSTOM_ISSUE_FIELD_MAPPING_ENABLED boolean
ATLASSIAN_DEFAULT_OFFERING_ISSUE_TYPE string
ATLASSIAN_EXCLUDED_ATTACHMENT_TYPES string
ATLASSIAN_DESCRIPTION_TEMPLATE string
ATLASSIAN_SUMMARY_TEMPLATE string
ATLASSIAN_AFFECTED_RESOURCE_FIELD string
ATLASSIAN_IMPACT_FIELD string
ATLASSIAN_ORGANISATION_FIELD string
ATLASSIAN_RESOLUTION_SLA_FIELD string
ATLASSIAN_PROJECT_FIELD string
ATLASSIAN_REPORTER_FIELD string
ATLASSIAN_CALLER_FIELD string
ATLASSIAN_SLA_FIELD string
ATLASSIAN_LINKED_ISSUE_TYPE string
ATLASSIAN_SATISFACTION_FIELD string
ATLASSIAN_REQUEST_FEEDBACK_FIELD string
ATLASSIAN_TEMPLATE_FIELD string
ATLASSIAN_WALDUR_BACKEND_ID_FIELD string
ZAMMAD_API_URL string (uri)
ZAMMAD_TOKEN string
ZAMMAD_GROUP string
ZAMMAD_ARTICLE_TYPE string
ZAMMAD_COMMENT_MARKER string
ZAMMAD_COMMENT_PREFIX string
ZAMMAD_COMMENT_COOLDOWN_DURATION integer
SMAX_API_URL string (uri)
SMAX_TENANT_ID string
SMAX_LOGIN string
SMAX_PASSWORD string
SMAX_ORGANISATION_FIELD string
SMAX_PROJECT_FIELD string
SMAX_AFFECTED_RESOURCE_FIELD string
SMAX_TIMES_TO_PULL integer
SMAX_SECONDS_TO_WAIT integer
SMAX_CREATION_SOURCE_NAME string
SMAX_REQUESTS_OFFERING string
SMAX_VERIFY_SSL boolean
ENABLE_MOCK_SERVICE_ACCOUNT_BACKEND boolean
ENABLE_MOCK_COURSE_ACCOUNT_BACKEND boolean
PROPOSAL_REVIEW_DURATION integer
ORCID_CLIENT_ID string
ORCID_CLIENT_SECRET string
ORCID_REDIRECT_URI string (uri)
ORCID_API_URL string (uri)
ORCID_AUTH_URL string (uri)
ORCID_SANDBOX_MODE boolean
SEMANTIC_SCHOLAR_API_KEY string
CROSSREF_MAILTO string (email)
REVIEWER_PROFILES_ENABLED boolean
COI_DETECTION_ENABLED boolean
COI_DISCLOSURE_REQUIRED boolean
AUTOMATED_MATCHING_ENABLED boolean
COI_COAUTHORSHIP_LOOKBACK_YEARS integer
COI_COAUTHORSHIP_THRESHOLD_PAPERS integer
COI_INSTITUTIONAL_LOOKBACK_YEARS integer
USER_TABLE_COLUMNS string
AUTO_APPROVE_USER_TOS boolean
FREEIPA_ENABLED boolean
FREEIPA_HOSTNAME string
FREEIPA_USERNAME string
FREEIPA_PASSWORD string
FREEIPA_VERIFY_SSL boolean
FREEIPA_USERNAME_PREFIX string
FREEIPA_GROUPNAME_PREFIX string
FREEIPA_BLACKLISTED_USERNAMES array of strings
FREEIPA_GROUP_SYNCHRONIZATION_ENABLED boolean
SCIM_MEMBERSHIP_SYNC_ENABLED boolean
SCIM_API_URL string
SCIM_API_KEY string
SCIM_URN_NAMESPACE string
KEYCLOAK_ICON string (uri)
COUNTRIES array of strings
OIDC_AUTH_URL string
OIDC_INTROSPECTION_URL string
OIDC_CLIENT_ID string
OIDC_CLIENT_SECRET string
OIDC_USER_FIELD string
OIDC_CACHE_TIMEOUT integer
OIDC_ACCESS_TOKEN_ENABLED boolean
OIDC_BLOCK_CREATION_OF_UNINVITED_USERS boolean
OIDC_MATCHMAKING_BY_EMAIL boolean
DEACTIVATE_USER_IF_NO_ROLES boolean
WALDUR_AUTH_SOCIAL_ROLE_CLAIM string
REMOTE_EDUTEAMS_REFRESH_TOKEN string
DEFAULT_OFFERING_USER_ATTRIBUTES array of anys
INVITATION_ALLOWED_FIELDS array of anys
ENABLED_USER_PROFILE_ATTRIBUTES array of anys
MANDATORY_USER_ATTRIBUTES array of anys
ENFORCE_MANDATORY_USER_ATTRIBUTES boolean
MAINTENANCE_ANNOUNCEMENT_NOTIFY_BEFORE_MINUTES integer
MAINTENANCE_ANNOUNCEMENT_NOTIFY_SYSTEM array of anys
ENFORCE_USER_CONSENT_FOR_OFFERINGS boolean
ENFORCE_OFFERING_USER_PROFILE_COMPLETENESS boolean
DISABLED_OFFERING_TYPES array of anys
ONBOARDING_VALIDATION_METHODS array of anys
ONBOARDING_VERIFICATION_EXPIRY_HOURS integer
ONBOARDING_ARIREGISTER_BASE_URL string (uri)
ONBOARDING_ARIREGISTER_USERNAME string
ONBOARDING_ARIREGISTER_PASSWORD string
ONBOARDING_ARIREGISTER_TIMEOUT integer
ONBOARDING_WICO_API_URL string (uri)
ONBOARDING_WICO_TOKEN string
ONBOARDING_BOLAGSVERKET_API_URL string (uri)
ONBOARDING_BOLAGSVERKET_TOKEN_API_URL string (uri)
ONBOARDING_BOLAGSVERKET_CLIENT_ID string
ONBOARDING_BOLAGSVERKET_CLIENT_SECRET string
ONBOARDING_BREG_API_URL string (uri)
LLM_CHAT_ENABLED boolean
LLM_INFERENCES_BACKEND_TYPE string
LLM_INFERENCES_API_URL string (uri)
LLM_INFERENCES_API_TOKEN string
LLM_INFERENCES_MODEL string
LLM_TOKEN_LIMIT_DAILY integer
LLM_TOKEN_LIMIT_WEEKLY integer
LLM_TOKEN_LIMIT_MONTHLY integer
LLM_CHAT_SESSION_RETENTION_DAYS integer
LLM_CHAT_HISTORY_LIMIT integer
LLM_INJECTION_ALLOWLIST string
SOFTWARE_CATALOG_EESSI_UPDATE_ENABLED boolean
SOFTWARE_CATALOG_EESSI_VERSION string
SOFTWARE_CATALOG_EESSI_API_URL string
SOFTWARE_CATALOG_EESSI_INCLUDE_EXTENSIONS boolean
SOFTWARE_CATALOG_SPACK_UPDATE_ENABLED boolean
SOFTWARE_CATALOG_SPACK_VERSION string
SOFTWARE_CATALOG_SPACK_DATA_URL string
SOFTWARE_CATALOG_UPDATE_EXISTING_PACKAGES boolean
SOFTWARE_CATALOG_CLEANUP_ENABLED boolean
SOFTWARE_CATALOG_RETENTION_DAYS integer
SYSTEM_LOG_ENABLED boolean
SYSTEM_LOG_MAX_ROWS_PER_SOURCE integer
TABLE_GROWTH_MONITORING_ENABLED boolean
TABLE_GROWTH_WEEKLY_THRESHOLD_PERCENT integer
TABLE_GROWTH_MONTHLY_THRESHOLD_PERCENT integer
TABLE_GROWTH_RETENTION_DAYS integer
TABLE_GROWTH_MIN_SIZE_BYTES integer
USER_ACTIONS_ENABLED boolean
USER_ACTIONS_PENDING_ORDER_HOURS integer
USER_ACTIONS_HIGH_URGENCY_NOTIFICATION boolean
USER_ACTIONS_NOTIFICATION_THRESHOLD integer
USER_ACTIONS_EXECUTION_RETENTION_DAYS integer
USER_ACTIONS_DEFAULT_EXPIRATION_REMINDERS array of strings
USER_DATA_ACCESS_LOGGING_ENABLED boolean
USER_DATA_ACCESS_LOG_RETENTION_DAYS integer
USER_DATA_ACCESS_LOG_SELF_ACCESS boolean
ARROW_AUTO_RECONCILIATION boolean
ARROW_SYNC_INTERVAL_HOURS integer
ARROW_CONSUMPTION_SYNC_ENABLED boolean
ARROW_CONSUMPTION_SYNC_INTERVAL_HOURS integer
ARROW_BILLING_CHECK_INTERVAL_HOURS integer
SLURM_POLICY_EVALUATION_LOG_RETENTION_DAYS integer
FEDERATED_IDENTITY_SYNC_ENABLED boolean
FEDERATED_IDENTITY_SYNC_ALLOWED_ATTRIBUTES array of anys
FEDERATED_IDENTITY_DEACTIVATION_POLICY string
ENABLE_PROJECT_DIGEST boolean

Other Actions

Update overridable settings

Updates one or more settings in the database via the Constance backend. Requires admin permissions.

1
2
3
4
http \
  POST \
  https://api.example.com/api/override-settings/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.constance_settings_request import ConstanceSettingsRequest # (1)
from waldur_api_client.api.override_settings import override_settings # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ConstanceSettingsRequest()
response = override_settings.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ConstanceSettingsRequest
  2. API Source: override_settings
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { overrideSettings } from 'waldur-js-client';

try {
  const response = await overrideSettings({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required
SITE_NAME string
SITE_DESCRIPTION string
HOMEPORT_URL string
RANCHER_USERNAME_INPUT_LABEL string
DISCLAIMER_AREA_TEXT string
SITE_ADDRESS string
SITE_EMAIL string
SITE_PHONE string
CURRENCY_NAME string
THUMBNAIL_SIZE string
ANONYMOUS_USER_CAN_VIEW_OFFERINGS boolean
ANONYMOUS_USER_CAN_VIEW_PLANS boolean
RESTRICTED_OFFERING_VISIBILITY_MODE string
ALLOW_SERVICE_PROVIDER_OFFERING_MANAGEMENT boolean
NOTIFY_STAFF_ABOUT_APPROVALS boolean
NOTIFY_ABOUT_RESOURCE_CHANGE boolean
DISABLE_SENDING_NOTIFICATIONS_ABOUT_RESOURCE_UPDATE boolean
MARKETPLACE_LANDING_PAGE string
ENABLE_STALE_RESOURCE_NOTIFICATIONS boolean
TELEMETRY_URL string
TELEMETRY_VERSION integer
SCRIPT_RUN_MODE string
DOCKER_CLIENT string
DOCKER_RUN_OPTIONS string
DOCKER_SCRIPT_DIR string
DOCKER_REMOVE_CONTAINER boolean
DOCKER_IMAGES string
DOCKER_VOLUME_NAME string
K8S_NAMESPACE string
K8S_CONFIG_PATH string
K8S_JOB_TIMEOUT integer
ENABLE_STRICT_CHECK_ACCEPTING_INVITATION boolean
INVITATION_DISABLE_MULTIPLE_ROLES boolean
DEFAULT_IDP any
DOCS_URL string (uri)
SHORT_PAGE_TITLE string
FULL_PAGE_TITLE string
PROJECT_END_DATE_MANDATORY boolean
ENABLE_ORDER_START_DATE boolean
BRAND_COLOR string
HERO_LINK_LABEL string
HERO_LINK_URL string (uri)
SUPPORT_PORTAL_URL string (uri)
COMMON_FOOTER_TEXT string
COMMON_FOOTER_HTML string
LANGUAGE_CHOICES string
DISABLE_DARK_THEME boolean
POWERED_BY_LOGO string (binary)
HERO_IMAGE string (binary)
MARKETPLACE_HERO_IMAGE string (binary)
CALL_MANAGEMENT_HERO_IMAGE string (binary)
SIDEBAR_LOGO string (binary)
SIDEBAR_LOGO_DARK string (binary)
SIDEBAR_LOGO_MOBILE string (binary)
SIDEBAR_STYLE string
FONT_FAMILY string
LOGIN_LOGO string (binary)
LOGIN_LOGO_MULTILINGUAL object (free-form)
LOGIN_PAGE_LAYOUT string
LOGIN_PAGE_VIDEO_URL string (uri)
LOGIN_PAGE_STATS array of anys
LOGIN_PAGE_CAROUSEL_SLIDES array of anys
LOGIN_PAGE_NEWS array of anys
FAVICON string (binary)
OFFERING_LOGO_PLACEHOLDER string (binary)
DISCLAIMER_AREA_LOGO string (binary)
WALDUR_SUPPORT_ENABLED boolean
WALDUR_SUPPORT_ACTIVE_BACKEND_TYPE string
WALDUR_SUPPORT_DISPLAY_REQUEST_TYPE boolean
ATLASSIAN_MAP_WALDUR_USERS_TO_SERVICEDESK_AGENTS boolean
ATLASSIAN_API_URL string (uri)
ATLASSIAN_USERNAME string
ATLASSIAN_PASSWORD string
ATLASSIAN_EMAIL string (email)
ATLASSIAN_USE_OLD_API boolean
ATLASSIAN_TOKEN string
ATLASSIAN_PERSONAL_ACCESS_TOKEN string
ATLASSIAN_OAUTH2_CLIENT_ID string
ATLASSIAN_OAUTH2_ACCESS_TOKEN string
ATLASSIAN_OAUTH2_TOKEN_TYPE string
ATLASSIAN_VERIFY_SSL boolean
ATLASSIAN_PROJECT_ID string
ATLASSIAN_SHARED_USERNAME boolean
ATLASSIAN_CUSTOM_ISSUE_FIELD_MAPPING_ENABLED boolean
ATLASSIAN_DEFAULT_OFFERING_ISSUE_TYPE string
ATLASSIAN_EXCLUDED_ATTACHMENT_TYPES string
ATLASSIAN_DESCRIPTION_TEMPLATE string
ATLASSIAN_SUMMARY_TEMPLATE string
ATLASSIAN_AFFECTED_RESOURCE_FIELD string
ATLASSIAN_IMPACT_FIELD string
ATLASSIAN_ORGANISATION_FIELD string
ATLASSIAN_RESOLUTION_SLA_FIELD string
ATLASSIAN_PROJECT_FIELD string
ATLASSIAN_REPORTER_FIELD string
ATLASSIAN_CALLER_FIELD string
ATLASSIAN_SLA_FIELD string
ATLASSIAN_LINKED_ISSUE_TYPE string
ATLASSIAN_SATISFACTION_FIELD string
ATLASSIAN_REQUEST_FEEDBACK_FIELD string
ATLASSIAN_TEMPLATE_FIELD string
ATLASSIAN_WALDUR_BACKEND_ID_FIELD string
ZAMMAD_API_URL string (uri)
ZAMMAD_TOKEN string
ZAMMAD_GROUP string
ZAMMAD_ARTICLE_TYPE string
ZAMMAD_COMMENT_MARKER string
ZAMMAD_COMMENT_PREFIX string
ZAMMAD_COMMENT_COOLDOWN_DURATION integer
SMAX_API_URL string (uri)
SMAX_TENANT_ID string
SMAX_LOGIN string
SMAX_PASSWORD string
SMAX_ORGANISATION_FIELD string
SMAX_PROJECT_FIELD string
SMAX_AFFECTED_RESOURCE_FIELD string
SMAX_TIMES_TO_PULL integer
SMAX_SECONDS_TO_WAIT integer
SMAX_CREATION_SOURCE_NAME string
SMAX_REQUESTS_OFFERING string
SMAX_VERIFY_SSL boolean
ENABLE_MOCK_SERVICE_ACCOUNT_BACKEND boolean
ENABLE_MOCK_COURSE_ACCOUNT_BACKEND boolean
PROPOSAL_REVIEW_DURATION integer
ORCID_CLIENT_ID string
ORCID_CLIENT_SECRET string
ORCID_REDIRECT_URI string (uri)
ORCID_API_URL string (uri)
ORCID_AUTH_URL string (uri)
ORCID_SANDBOX_MODE boolean
SEMANTIC_SCHOLAR_API_KEY string
CROSSREF_MAILTO string (email)
REVIEWER_PROFILES_ENABLED boolean
COI_DETECTION_ENABLED boolean
COI_DISCLOSURE_REQUIRED boolean
AUTOMATED_MATCHING_ENABLED boolean
COI_COAUTHORSHIP_LOOKBACK_YEARS integer
COI_COAUTHORSHIP_THRESHOLD_PAPERS integer
COI_INSTITUTIONAL_LOOKBACK_YEARS integer
USER_TABLE_COLUMNS string
AUTO_APPROVE_USER_TOS boolean
FREEIPA_ENABLED boolean
FREEIPA_HOSTNAME string
FREEIPA_USERNAME string
FREEIPA_PASSWORD string
FREEIPA_VERIFY_SSL boolean
FREEIPA_USERNAME_PREFIX string
FREEIPA_GROUPNAME_PREFIX string
FREEIPA_BLACKLISTED_USERNAMES array of strings
FREEIPA_GROUP_SYNCHRONIZATION_ENABLED boolean
SCIM_MEMBERSHIP_SYNC_ENABLED boolean
SCIM_API_URL string
SCIM_API_KEY string
SCIM_URN_NAMESPACE string
KEYCLOAK_ICON string (binary)
COUNTRIES array of strings
OIDC_AUTH_URL string
OIDC_INTROSPECTION_URL string
OIDC_CLIENT_ID string
OIDC_CLIENT_SECRET string
OIDC_USER_FIELD string
OIDC_CACHE_TIMEOUT integer
OIDC_ACCESS_TOKEN_ENABLED boolean
OIDC_BLOCK_CREATION_OF_UNINVITED_USERS boolean
OIDC_MATCHMAKING_BY_EMAIL boolean
DEACTIVATE_USER_IF_NO_ROLES boolean
WALDUR_AUTH_SOCIAL_ROLE_CLAIM string
REMOTE_EDUTEAMS_REFRESH_TOKEN string
DEFAULT_OFFERING_USER_ATTRIBUTES array of anys
INVITATION_ALLOWED_FIELDS array of anys
ENABLED_USER_PROFILE_ATTRIBUTES array of anys
MANDATORY_USER_ATTRIBUTES array of anys
ENFORCE_MANDATORY_USER_ATTRIBUTES boolean
MAINTENANCE_ANNOUNCEMENT_NOTIFY_BEFORE_MINUTES integer
MAINTENANCE_ANNOUNCEMENT_NOTIFY_SYSTEM array of anys
ENFORCE_USER_CONSENT_FOR_OFFERINGS boolean
ENFORCE_OFFERING_USER_PROFILE_COMPLETENESS boolean
DISABLED_OFFERING_TYPES array of anys
ONBOARDING_VALIDATION_METHODS array of anys
ONBOARDING_VERIFICATION_EXPIRY_HOURS integer
ONBOARDING_ARIREGISTER_BASE_URL string (uri)
ONBOARDING_ARIREGISTER_USERNAME string
ONBOARDING_ARIREGISTER_PASSWORD string
ONBOARDING_ARIREGISTER_TIMEOUT integer
ONBOARDING_WICO_API_URL string (uri)
ONBOARDING_WICO_TOKEN string
ONBOARDING_BOLAGSVERKET_API_URL string (uri)
ONBOARDING_BOLAGSVERKET_TOKEN_API_URL string (uri)
ONBOARDING_BOLAGSVERKET_CLIENT_ID string
ONBOARDING_BOLAGSVERKET_CLIENT_SECRET string
ONBOARDING_BREG_API_URL string (uri)
LLM_CHAT_ENABLED boolean
LLM_INFERENCES_BACKEND_TYPE string
LLM_INFERENCES_API_URL string (uri)
LLM_INFERENCES_API_TOKEN string
LLM_INFERENCES_MODEL string
LLM_TOKEN_LIMIT_DAILY integer
LLM_TOKEN_LIMIT_WEEKLY integer
LLM_TOKEN_LIMIT_MONTHLY integer
LLM_CHAT_SESSION_RETENTION_DAYS integer
LLM_CHAT_HISTORY_LIMIT integer
LLM_INJECTION_ALLOWLIST string
SOFTWARE_CATALOG_EESSI_UPDATE_ENABLED boolean
SOFTWARE_CATALOG_EESSI_VERSION string
SOFTWARE_CATALOG_EESSI_API_URL string
SOFTWARE_CATALOG_EESSI_INCLUDE_EXTENSIONS boolean
SOFTWARE_CATALOG_SPACK_UPDATE_ENABLED boolean
SOFTWARE_CATALOG_SPACK_VERSION string
SOFTWARE_CATALOG_SPACK_DATA_URL string
SOFTWARE_CATALOG_UPDATE_EXISTING_PACKAGES boolean
SOFTWARE_CATALOG_CLEANUP_ENABLED boolean
SOFTWARE_CATALOG_RETENTION_DAYS integer
SYSTEM_LOG_ENABLED boolean
SYSTEM_LOG_MAX_ROWS_PER_SOURCE integer
TABLE_GROWTH_MONITORING_ENABLED boolean
TABLE_GROWTH_WEEKLY_THRESHOLD_PERCENT integer
TABLE_GROWTH_MONTHLY_THRESHOLD_PERCENT integer
TABLE_GROWTH_RETENTION_DAYS integer
TABLE_GROWTH_MIN_SIZE_BYTES integer
USER_ACTIONS_ENABLED boolean
USER_ACTIONS_PENDING_ORDER_HOURS integer
USER_ACTIONS_HIGH_URGENCY_NOTIFICATION boolean
USER_ACTIONS_NOTIFICATION_THRESHOLD integer
USER_ACTIONS_EXECUTION_RETENTION_DAYS integer
USER_ACTIONS_DEFAULT_EXPIRATION_REMINDERS array of strings
USER_DATA_ACCESS_LOGGING_ENABLED boolean
USER_DATA_ACCESS_LOG_RETENTION_DAYS integer
USER_DATA_ACCESS_LOG_SELF_ACCESS boolean
ARROW_AUTO_RECONCILIATION boolean
ARROW_SYNC_INTERVAL_HOURS integer
ARROW_CONSUMPTION_SYNC_ENABLED boolean
ARROW_CONSUMPTION_SYNC_INTERVAL_HOURS integer
ARROW_BILLING_CHECK_INTERVAL_HOURS integer
SLURM_POLICY_EVALUATION_LOG_RETENTION_DAYS integer
FEDERATED_IDENTITY_SYNC_ENABLED boolean
FEDERATED_IDENTITY_SYNC_ALLOWED_ATTRIBUTES array of anys
FEDERATED_IDENTITY_DEACTIVATION_POLICY string
ENABLE_PROJECT_DIGEST boolean

200 - No response body

Query

Operations Summary

Method Endpoint Description
POST /api/query/ Execute read-only SQL query

Execute read-only SQL query

Execute a given SQL query against a read-only database replica. This is a powerful tool for diagnostics and reporting, but should be used with caution. Requires support user permissions.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/query/ \
  Authorization:"Token YOUR_API_TOKEN" \
  query="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.query_request import QueryRequest # (1)
from waldur_api_client.api.query import query # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = QueryRequest(
    query="string-value"
)
response = query.sync(
    client=client,
    body=body_data
)

for item in response:
    print(item)
  1. Model Source: QueryRequest
  2. API Source: query
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { query } from 'waldur-js-client';

try {
  const response = await query({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "query": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
query string ✓ Search query string

200 -

400 - No response body

Stats

Operations Summary

Method Endpoint Description
GET /api/stats/celery/ Get Celery worker statistics
GET /api/stats/database/ Get comprehensive database statistics
GET /api/stats/table-growth/ Get table growth statistics
POST /api/stats/query/ Execute read-only SQL query

Get Celery worker statistics

Provides a comprehensive snapshot of all Celery workers' status.

This endpoint returns detailed information about: - active: Tasks currently being executed by workers - scheduled: Tasks scheduled for future execution (with ETA) - reserved: Tasks received by workers but not yet started - revoked: Task IDs that have been cancelled/revoked - query_task: Results of task queries (if any) - stats: Detailed worker statistics including uptime, pool info, and broker connection

Each field is a dictionary where keys are worker names (e.g., 'celery@hostname'). If no workers are available, fields will be null.

Requires support user permissions.

1
2
3
4
http \
  GET \
  https://api.example.com/api/stats/celery/ \
  Authorization:"Token YOUR_API_TOKEN"

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.stats import stats_celery_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = stats_celery_retrieve.sync(client=client)

print(response)
  1. API Source: stats_celery_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { statsCeleryRetrieve } from 'waldur-js-client';

try {
  const response = await statsCeleryRetrieve({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

200 -

Field Type Description
active object (free-form) Currently executing tasks per worker. Keys are worker names, values are lists of active tasks.
scheduled object (free-form) Tasks scheduled for future execution per worker. Keys are worker names, values are lists of scheduled tasks with ETA.
reserved object (free-form) Tasks that have been received but not yet started per worker. Keys are worker names, values are lists of reserved tasks.
revoked object (free-form) IDs of revoked (cancelled) tasks per worker. Keys are worker names, values are lists of task IDs.
query_task object (free-form) Query results for specific tasks. May be null if no query was performed.
stats object (free-form) Detailed statistics per worker including uptime, pool info, and resource usage. Keys are worker names.

Get comprehensive database statistics

Retrieves comprehensive statistics about the PostgreSQL database including: - Table statistics: Top 10 largest tables by size - Connection statistics: Active, idle, and waiting connections with utilization - Database size: Total size, data size, and index size - Cache performance: Buffer cache and index hit ratios (should be >99%) - Transaction statistics: Commits, rollbacks, deadlocks - Lock statistics: Current locks and waiting queries - Maintenance statistics: Dead tuples, vacuum needs, oldest transaction age - Active queries: Currently running queries with duration - Query performance: Sequential vs index scan ratios - Replication status: WAL size and replication lag (if applicable)

This information is useful for monitoring, debugging, and performance tuning. Requires support user permissions.

1
2
3
4
http \
  GET \
  https://api.example.com/api/stats/database/ \
  Authorization:"Token YOUR_API_TOKEN"

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.stats import stats_database_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = stats_database_retrieve.sync(client=client)

print(response)
  1. API Source: stats_database_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { statsDatabaseRetrieve } from 'waldur-js-client';

try {
  const response = await statsDatabaseRetrieve({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

200 -

Field Type Description
table_stats array of objects Top largest tables by size
table_stats.table_name string Name of the database table
table_stats.total_size integer Total size of the table in bytes
table_stats.data_size integer Size of the actual data in bytes
table_stats.external_size integer Size of external data (e.g., TOAST) in bytes
connections any Connection statistics
database_size any Database size information
cache_performance any Cache hit ratios and memory settings
transactions any Transaction commit/rollback statistics
locks any Current lock statistics
maintenance any Vacuum and maintenance statistics
active_queries any Currently running queries
query_performance any Query performance indicators
replication any Replication status (if applicable)

Get table growth statistics

Retrieves historical table growth statistics for detecting abnormal patterns.

This endpoint returns: - date: Current date of the statistics - weekly_threshold_percent: Configured alert threshold for weekly growth - monthly_threshold_percent: Configured alert threshold for monthly growth - tables: List of tables with their growth statistics, sorted by growth rate

Each table entry includes: - Current size and row estimates - Size and row estimates from 7 days ago - Size and row estimates from 30 days ago - Weekly and monthly growth percentages

Use this data to identify tables that may be experiencing abnormal growth, which could indicate bugs like the version-based get_or_create issue.

Query parameters: - table_name (optional): Filter to a specific table name - days (optional, default 30): Number of days of history to include

Requires support user permissions.

1
2
3
4
http \
  GET \
  https://api.example.com/api/stats/table-growth/ \
  Authorization:"Token YOUR_API_TOKEN"

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.stats import stats_table_growth_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = stats_table_growth_retrieve.sync(client=client)

print(response)
  1. API Source: stats_table_growth_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { statsTableGrowthRetrieve } from 'waldur-js-client';

try {
  const response = await statsTableGrowthRetrieve({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

200 -

Field Type Description
date string (date) Current date of the statistics
weekly_threshold_percent integer Configured weekly growth alert threshold
monthly_threshold_percent integer Configured monthly growth alert threshold
tables array of objects Table growth statistics sorted by growth rate
tables.table_name string Name of the database table
tables.current_total_size integer Current total size including indexes in bytes
tables.current_data_size integer Current data-only size in bytes
tables.current_row_estimate integer Current estimated row count
tables.week_ago_total_size integer Total size from 7 days ago in bytes
tables.week_ago_row_estimate integer Row estimate from 7 days ago
tables.month_ago_total_size integer Total size from 30 days ago in bytes
tables.month_ago_row_estimate integer Row estimate from 30 days ago
tables.weekly_growth_percent number (double) Percentage growth over the past week
tables.monthly_growth_percent number (double) Percentage growth over the past month
tables.weekly_row_growth_percent number (double) Percentage row count growth over the past week
tables.monthly_row_growth_percent number (double) Percentage row count growth over the past month
alerts array of objects List of tables that exceeded configured growth thresholds
alerts.table_name string Name of the table triggering the alert
alerts.period any Growth period that exceeded the threshold
alerts.growth_percent number (double) Actual growth percentage observed
alerts.threshold integer Configured threshold that was exceeded

Execute read-only SQL query

Execute a given SQL query against a read-only database replica. This is a powerful tool for diagnostics and reporting, but should be used with caution. Requires support user permissions.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/stats/query/ \
  Authorization:"Token YOUR_API_TOKEN" \
  query="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.query_request import QueryRequest # (1)
from waldur_api_client.api.stats import stats_query # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = QueryRequest(
    query="string-value"
)
response = stats_query.sync(
    client=client,
    body=body_data
)

for item in response:
    print(item)
  1. Model Source: QueryRequest
  2. API Source: stats_query
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { statsQuery } from 'waldur-js-client';

try {
  const response = await statsQuery({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "query": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
query string ✓ Search query string

200 -

400 - No response body

User Agreements

Operations Summary

Method Endpoint Description
GET /api/user-agreements/ List user agreements
GET /api/user-agreements/{uuid}/ Retrieve user agreement
POST /api/user-agreements/ Create
PUT /api/user-agreements/{uuid}/ Update
PATCH /api/user-agreements/{uuid}/ Partial Update
DELETE /api/user-agreements/{uuid}/ Delete

List user agreements

Retrieve a list of user agreements (Terms of Service and Privacy Policy). Supports filtering by agreement type and language with fallback behavior.

1
2
3
4
http \
  GET \
  https://api.example.com/api/user-agreements/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.agreement_type_enum import AgreementTypeEnum # (1)
from waldur_api_client.api.user_agreements import user_agreements_list # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = user_agreements_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: AgreementTypeEnum
  2. API Source: user_agreements_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { userAgreementsList } from 'waldur-js-client';

try {
  const response = await userAgreementsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
agreement_type string Enum: TOS, PP
language string ISO 639-1 language code (e.g., 'en', 'de', 'et'). Returns requested language or falls back to default version if unavailable.
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
content string
agreement_type string
Enum: TOS, PP
language string ISO 639-1 language code (e.g., 'en', 'de', 'et'). Leave empty for the default version.
created string (date-time)
modified string (date-time)

Retrieve user agreement

Fetch the details of a specific user agreement by its UUID.

1
2
3
4
http \
  GET \
  https://api.example.com/api/user-agreements/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.user_agreements import user_agreements_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = user_agreements_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: user_agreements_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { userAgreementsRetrieve } from 'waldur-js-client';

try {
  const response = await userAgreementsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
url string (uri)
uuid string (uuid)
content string
agreement_type string
Enum: TOS, PP
language string ISO 639-1 language code (e.g., 'en', 'de', 'et'). Leave empty for the default version.
created string (date-time)
modified string (date-time)

Create

1
2
3
4
5
6
7
http \
  POST \
  https://api.example.com/api/user-agreements/ \
  Authorization:"Token YOUR_API_TOKEN" \
  content="string-value" \
  agreement_type="TOS" \
  language="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.user_agreement_request import UserAgreementRequest # (1)
from waldur_api_client.api.user_agreements import user_agreements_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = UserAgreementRequest(
    content="string-value",
    agreement_type="TOS",
    language="string-value"
)
response = user_agreements_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: UserAgreementRequest
  2. API Source: user_agreements_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
import { userAgreementsCreate } from 'waldur-js-client';

try {
  const response = await userAgreementsCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "content": "string-value",
    "agreement_type": "TOS",
    "language": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
content string ✓
agreement_type string ✓
Enum: TOS, PP
language string ✓ ISO 639-1 language code (e.g., 'en', 'de', 'et'). Leave empty for the default version.

201 -

Field Type Description
url string (uri)
uuid string (uuid)
content string
agreement_type string
Enum: TOS, PP
language string ISO 639-1 language code (e.g., 'en', 'de', 'et'). Leave empty for the default version.
created string (date-time)
modified string (date-time)

Update

1
2
3
4
5
6
7
http \
  PUT \
  https://api.example.com/api/user-agreements/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  content="string-value" \
  agreement_type="TOS" \
  language="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.user_agreement_request import UserAgreementRequest # (1)
from waldur_api_client.api.user_agreements import user_agreements_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = UserAgreementRequest(
    content="string-value",
    agreement_type="TOS",
    language="string-value"
)
response = user_agreements_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: UserAgreementRequest
  2. API Source: user_agreements_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
import { userAgreementsUpdate } from 'waldur-js-client';

try {
  const response = await userAgreementsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "content": "string-value",
    "agreement_type": "TOS",
    "language": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
content string ✓
agreement_type string ✓
Enum: TOS, PP
language string ✓ ISO 639-1 language code (e.g., 'en', 'de', 'et'). Leave empty for the default version.

200 -

Field Type Description
url string (uri)
uuid string (uuid)
content string
agreement_type string
Enum: TOS, PP
language string ISO 639-1 language code (e.g., 'en', 'de', 'et'). Leave empty for the default version.
created string (date-time)
modified string (date-time)

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/user-agreements/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_user_agreement_request import PatchedUserAgreementRequest # (1)
from waldur_api_client.api.user_agreements import user_agreements_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedUserAgreementRequest()
response = user_agreements_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedUserAgreementRequest
  2. API Source: user_agreements_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { userAgreementsPartialUpdate } from 'waldur-js-client';

try {
  const response = await userAgreementsPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
content string
agreement_type string
Enum: TOS, PP
language string ISO 639-1 language code (e.g., 'en', 'de', 'et'). Leave empty for the default version.

200 -

Field Type Description
url string (uri)
uuid string (uuid)
content string
agreement_type string
Enum: TOS, PP
language string ISO 639-1 language code (e.g., 'en', 'de', 'et'). Leave empty for the default version.
created string (date-time)
modified string (date-time)

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/user-agreements/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.user_agreements import user_agreements_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = user_agreements_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: user_agreements_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { userAgreementsDestroy } from 'waldur-js-client';

try {
  const response = await userAgreementsDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Version

Operations Summary

Method Endpoint Description
GET /api/version/ Get application version

Get application version

Retrieves the current installed version of the application and the latest available version from GitHub (if available). Requires staff or support user permissions.

1
2
3
4
http \
  GET \
  https://api.example.com/api/version/ \
  Authorization:"Token YOUR_API_TOKEN"

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.version import version_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = version_retrieve.sync(client=client)

print(response)
  1. API Source: version_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { versionRetrieve } from 'waldur-js-client';

try {
  const response = await versionRetrieve({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

200 -

Field Type Description
version string Current installed version of the application
latest_version string Latest available version from GitHub, if available.

Marketplace

Accounts

Marketplace Course Accounts

Operations Summary

Method Endpoint Description
GET /api/marketplace-course-accounts/ List course accounts
GET /api/marketplace-course-accounts/{uuid}/ Retrieve a course account
POST /api/marketplace-course-accounts/ Create a course account
POST /api/marketplace-course-accounts/create_bulk/ Bulk create course accounts
DELETE /api/marketplace-course-accounts/{uuid}/ Delete (close) a course account

List course accounts

Returns a paginated list of course accounts accessible to the current user.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-course-accounts/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.course_account_o_enum import CourseAccountOEnum # (1)
from waldur_api_client.models.service_account_state import ServiceAccountState # (2)
from waldur_api_client.api.marketplace_course_accounts import marketplace_course_accounts_list # (3)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_course_accounts_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: CourseAccountOEnum
  2. Model Source: ServiceAccountState
  3. API Source: marketplace_course_accounts_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceCourseAccountsList } from 'waldur-js-client';

try {
  const response = await marketplaceCourseAccountsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
email string Email contains
o array Ordering
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
project_end_date_after string (date) Project end date range
project_end_date_before string (date) Project end date range
project_start_date_after string (date) Project start date range
project_start_date_before string (date) Project start date range
project_uuid string (uuid) Project UUID
state array Course account state
username string Username

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
url string (uri)
uuid string (uuid)
created string (date-time)
modified string (date-time)
project string (uuid)
project_uuid string (uuid)
project_name string
project_slug string
project_start_date string (date)
project_end_date string (date)
user_uuid string (uuid)
username string
customer_uuid string (uuid)
customer_name string
state any
email string (email)
description string
error_message string
error_traceback string

Retrieve a course account

Returns the details of a specific course account.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-course-accounts/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_course_accounts import marketplace_course_accounts_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_course_accounts_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_course_accounts_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceCourseAccountsRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceCourseAccountsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
url string (uri)
uuid string (uuid)
created string (date-time)
modified string (date-time)
project string (uuid)
project_uuid string (uuid)
project_name string
project_slug string
project_start_date string (date)
project_end_date string (date)
user_uuid string (uuid)
username string
customer_uuid string (uuid)
customer_name string
state any
email string (email)
description string
error_message string
error_traceback string

Create a course account

Creates a new temporary course account within a specified course project.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/marketplace-course-accounts/ \
  Authorization:"Token YOUR_API_TOKEN" \
  project="a1b2c3d4-e5f6-7890-abcd-ef1234567890"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.course_account_request import CourseAccountRequest # (1)
from waldur_api_client.api.marketplace_course_accounts import marketplace_course_accounts_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = CourseAccountRequest(
    project="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
)
response = marketplace_course_accounts_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: CourseAccountRequest
  2. API Source: marketplace_course_accounts_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceCourseAccountsCreate } from 'waldur-js-client';

try {
  const response = await marketplaceCourseAccountsCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "project": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required
project string (uuid) ✓
email string (email)
description string

201 -

Field Type
url string (uri)
uuid string (uuid)
created string (date-time)
modified string (date-time)
project string (uuid)
project_uuid string (uuid)
project_name string
project_slug string
project_start_date string (date)
project_end_date string (date)
user_uuid string (uuid)
username string
customer_uuid string (uuid)
customer_name string
state any
email string (email)
description string
error_message string
error_traceback string

Bulk create course accounts

Creates multiple course accounts within a specified course project in a single request.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/marketplace-course-accounts/create_bulk/ \
  Authorization:"Token YOUR_API_TOKEN" \
  course_accounts:='[]' \
  project="a1b2c3d4-e5f6-7890-abcd-ef1234567890"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.course_account_o_enum import CourseAccountOEnum # (1)
from waldur_api_client.models.course_accounts_bulk_create_request import CourseAccountsBulkCreateRequest # (2)
from waldur_api_client.models.service_account_state import ServiceAccountState # (3)
from waldur_api_client.api.marketplace_course_accounts import marketplace_course_accounts_create_bulk # (4)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = CourseAccountsBulkCreateRequest(
    course_accounts=[],
    project="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
)
response = marketplace_course_accounts_create_bulk.sync(
    client=client,
    body=body_data
)

for item in response:
    print(item)
  1. Model Source: CourseAccountOEnum
  2. Model Source: CourseAccountsBulkCreateRequest
  3. Model Source: ServiceAccountState
  4. API Source: marketplace_course_accounts_create_bulk
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { marketplaceCourseAccountsCreateBulk } from 'waldur-js-client';

try {
  const response = await marketplaceCourseAccountsCreateBulk({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "course_accounts": [],
    "project": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
email string Email contains
o array Ordering
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
project_end_date_after string (date) Project end date range
project_end_date_before string (date) Project end date range
project_start_date_after string (date) Project start date range
project_start_date_before string (date) Project start date range
project_uuid string (uuid) Project UUID
state array Course account state
username string Username
Field Type Required
course_accounts array of objects ✓
course_accounts.email string (email)
course_accounts.description string
project string (uuid) ✓

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
url string (uri)
uuid string (uuid)
created string (date-time)
modified string (date-time)
project string (uuid)
project_uuid string (uuid)
project_name string
project_slug string
project_start_date string (date)
project_end_date string (date)
user_uuid string (uuid)
username string
customer_uuid string (uuid)
customer_name string
state any
email string (email)
description string
error_message string
error_traceback string

Delete (close) a course account

Deletes a course account, which triggers a 'close' operation in the backend.

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/marketplace-course-accounts/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_course_accounts import marketplace_course_accounts_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_course_accounts_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_course_accounts_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceCourseAccountsDestroy } from 'waldur-js-client';

try {
  const response = await marketplaceCourseAccountsDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Marketplace Customer Service Accounts

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/marketplace-customer-service-accounts/ List service accounts
GET /api/marketplace-customer-service-accounts/{uuid}/ Retrieve a service account
POST /api/marketplace-customer-service-accounts/ Create a customer service account
PUT /api/marketplace-customer-service-accounts/{uuid}/ Update a service account
PATCH /api/marketplace-customer-service-accounts/{uuid}/ Partially update a service account
DELETE /api/marketplace-customer-service-accounts/{uuid}/ Close a customer service account
Other Actions
POST /api/marketplace-customer-service-accounts/{uuid}/rotate_api_key/ Rotate API key for a customer service account

Core CRUD

List service accounts

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-customer-service-accounts/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.service_account_state import ServiceAccountState # (1)
from waldur_api_client.api.marketplace_customer_service_accounts import marketplace_customer_service_accounts_list # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_customer_service_accounts_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: ServiceAccountState
  2. API Source: marketplace_customer_service_accounts_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceCustomerServiceAccountsList } from 'waldur-js-client';

try {
  const response = await marketplaceCustomerServiceAccountsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
customer string (uri) Customer URL
customer_uuid string (uuid) Customer UUID
email string Email contains
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
state array Service account state
username string Username

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
url string (uri)
uuid string (uuid)
created string (date-time)
modified string (date-time)
username string
description string
error_message string
error_traceback string
state any
token string
email string (email)
expires_at string
preferred_identifier string
customer string (uuid)
customer_uuid string (uuid)
customer_name string

Retrieve a service account

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-customer-service-accounts/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_customer_service_accounts import marketplace_customer_service_accounts_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_customer_service_accounts_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_customer_service_accounts_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceCustomerServiceAccountsRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceCustomerServiceAccountsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
url string (uri)
uuid string (uuid)
created string (date-time)
modified string (date-time)
username string
description string
error_message string
error_traceback string
state any
token string
email string (email)
expires_at string
preferred_identifier string
customer string (uuid)
customer_uuid string (uuid)
customer_name string

Create a customer service account

Creates a new service account scoped to a specific customer (organization). This generates an API key that can be used for automated access to resources across all projects within that customer.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/marketplace-customer-service-accounts/ \
  Authorization:"Token YOUR_API_TOKEN" \
  customer="a1b2c3d4-e5f6-7890-abcd-ef1234567890"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.customer_service_account_request import CustomerServiceAccountRequest # (1)
from waldur_api_client.api.marketplace_customer_service_accounts import marketplace_customer_service_accounts_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = CustomerServiceAccountRequest(
    customer="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
)
response = marketplace_customer_service_accounts_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: CustomerServiceAccountRequest
  2. API Source: marketplace_customer_service_accounts_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceCustomerServiceAccountsCreate } from 'waldur-js-client';

try {
  const response = await marketplaceCustomerServiceAccountsCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "customer": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required
username string
description string
error_traceback string
email string (email)
preferred_identifier string
customer string (uuid) ✓

201 -

Field Type
url string (uri)
uuid string (uuid)
created string (date-time)
modified string (date-time)
username string
description string
error_message string
error_traceback string
state any
token string
email string (email)
expires_at string
preferred_identifier string
customer string (uuid)
customer_uuid string (uuid)
customer_name string

Update a service account

1
2
3
4
5
http \
  PUT \
  https://api.example.com/api/marketplace-customer-service-accounts/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  customer="a1b2c3d4-e5f6-7890-abcd-ef1234567890"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.customer_service_account_request import CustomerServiceAccountRequest # (1)
from waldur_api_client.api.marketplace_customer_service_accounts import marketplace_customer_service_accounts_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = CustomerServiceAccountRequest(
    customer="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
)
response = marketplace_customer_service_accounts_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: CustomerServiceAccountRequest
  2. API Source: marketplace_customer_service_accounts_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { marketplaceCustomerServiceAccountsUpdate } from 'waldur-js-client';

try {
  const response = await marketplaceCustomerServiceAccountsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "customer": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
username string
description string
error_traceback string
email string (email)
preferred_identifier string
customer string (uuid) ✓

200 -

Field Type
url string (uri)
uuid string (uuid)
created string (date-time)
modified string (date-time)
username string
description string
error_message string
error_traceback string
state any
token string
email string (email)
expires_at string
preferred_identifier string
customer string (uuid)
customer_uuid string (uuid)
customer_name string

Partially update a service account

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/marketplace-customer-service-accounts/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_customer_service_account_request import PatchedCustomerServiceAccountRequest # (1)
from waldur_api_client.api.marketplace_customer_service_accounts import marketplace_customer_service_accounts_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedCustomerServiceAccountRequest()
response = marketplace_customer_service_accounts_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedCustomerServiceAccountRequest
  2. API Source: marketplace_customer_service_accounts_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceCustomerServiceAccountsPartialUpdate } from 'waldur-js-client';

try {
  const response = await marketplaceCustomerServiceAccountsPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
username string
description string
error_traceback string
email string (email)
preferred_identifier string
customer string (uuid)

200 -

Field Type
url string (uri)
uuid string (uuid)
created string (date-time)
modified string (date-time)
username string
description string
error_message string
error_traceback string
state any
token string
email string (email)
expires_at string
preferred_identifier string
customer string (uuid)
customer_uuid string (uuid)
customer_name string

Close a customer service account

Deactivates a customer service account and revokes its API key.

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/marketplace-customer-service-accounts/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_customer_service_accounts import marketplace_customer_service_accounts_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_customer_service_accounts_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_customer_service_accounts_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceCustomerServiceAccountsDestroy } from 'waldur-js-client';

try {
  const response = await marketplaceCustomerServiceAccountsDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Other Actions

Rotate API key for a customer service account

Generates a new API key for the service account, immediately invalidating the old one. The new key is returned in the response.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-customer-service-accounts/a1b2c3d4-e5f6-7890-abcd-ef1234567890/rotate_api_key/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_customer_service_accounts import marketplace_customer_service_accounts_rotate_api_key # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_customer_service_accounts_rotate_api_key.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_customer_service_accounts_rotate_api_key
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceCustomerServiceAccountsRotateApiKey } from 'waldur-js-client';

try {
  const response = await marketplaceCustomerServiceAccountsRotateApiKey({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
url string (uri)
uuid string (uuid)
created string (date-time)
modified string (date-time)
username string
description string
error_message string
error_traceback string
state any
token string
email string (email)
expires_at string
preferred_identifier string
customer string (uuid)
customer_uuid string (uuid)
customer_name string

Marketplace Offering User Roles

Operations Summary

Method Endpoint Description
GET /api/marketplace-offering-user-roles/ List Marketplace Offering User Roles
GET /api/marketplace-offering-user-roles/{uuid}/ Retrieve
POST /api/marketplace-offering-user-roles/ Create
PUT /api/marketplace-offering-user-roles/{uuid}/ Update
PATCH /api/marketplace-offering-user-roles/{uuid}/ Partial Update
DELETE /api/marketplace-offering-user-roles/{uuid}/ Delete

List Marketplace Offering User Roles

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-offering-user-roles/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_offering_user_roles import marketplace_offering_user_roles_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_offering_user_roles_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: marketplace_offering_user_roles_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceOfferingUserRolesList } from 'waldur-js-client';

try {
  const response = await marketplaceOfferingUserRolesList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
offering string (uri)
offering_slug array Multiple values may be separated by commas.
offering_uuid array Multiple values may be separated by commas.
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
parent_offering_uuid string (uuid)

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
name string
uuid string (uuid)
offering string (uri)
offering_uuid string (uuid)
offering_name string
scope_type string Level this role applies at, e.g. 'cluster', 'project'. Empty means offering-wide.
scope_type_label string Human-readable label for scope_type shown to end users, e.g. 'Rancher Project', 'Cluster Namespace'. Falls back to capitalized scope_type if empty.

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-offering-user-roles/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_offering_user_roles import marketplace_offering_user_roles_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_offering_user_roles_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_offering_user_roles_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceOfferingUserRolesRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceOfferingUserRolesRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
name string
uuid string (uuid)
offering string (uri)
offering_uuid string (uuid)
offering_name string
scope_type string Level this role applies at, e.g. 'cluster', 'project'. Empty means offering-wide.
scope_type_label string Human-readable label for scope_type shown to end users, e.g. 'Rancher Project', 'Cluster Namespace'. Falls back to capitalized scope_type if empty.

Create

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/marketplace-offering-user-roles/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-marketplace-offering-user-role" \
  offering="https://api.example.com/api/offering/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.offering_user_role_request import OfferingUserRoleRequest # (1)
from waldur_api_client.api.marketplace_offering_user_roles import marketplace_offering_user_roles_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OfferingUserRoleRequest(
    name="my-awesome-marketplace-offering-user-role",
    offering="https://api.example.com/api/offering/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = marketplace_offering_user_roles_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OfferingUserRoleRequest
  2. API Source: marketplace_offering_user_roles_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { marketplaceOfferingUserRolesCreate } from 'waldur-js-client';

try {
  const response = await marketplaceOfferingUserRolesCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "name": "my-awesome-marketplace-offering-user-role",
    "offering": "https://api.example.com/api/offering/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
name string ✓
offering string (uri) ✓
scope_type string Level this role applies at, e.g. 'cluster', 'project'. Empty means offering-wide.
scope_type_label string Human-readable label for scope_type shown to end users, e.g. 'Rancher Project', 'Cluster Namespace'. Falls back to capitalized scope_type if empty.

201 -

Field Type Description
name string
uuid string (uuid)
offering string (uri)
offering_uuid string (uuid)
offering_name string
scope_type string Level this role applies at, e.g. 'cluster', 'project'. Empty means offering-wide.
scope_type_label string Human-readable label for scope_type shown to end users, e.g. 'Rancher Project', 'Cluster Namespace'. Falls back to capitalized scope_type if empty.

Update

1
2
3
4
5
6
http \
  PUT \
  https://api.example.com/api/marketplace-offering-user-roles/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-marketplace-offering-user-role" \
  offering="https://api.example.com/api/offering/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.offering_user_role_request import OfferingUserRoleRequest # (1)
from waldur_api_client.api.marketplace_offering_user_roles import marketplace_offering_user_roles_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OfferingUserRoleRequest(
    name="my-awesome-marketplace-offering-user-role",
    offering="https://api.example.com/api/offering/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = marketplace_offering_user_roles_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OfferingUserRoleRequest
  2. API Source: marketplace_offering_user_roles_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { marketplaceOfferingUserRolesUpdate } from 'waldur-js-client';

try {
  const response = await marketplaceOfferingUserRolesUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-marketplace-offering-user-role",
    "offering": "https://api.example.com/api/offering/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
name string ✓
offering string (uri) ✓
scope_type string Level this role applies at, e.g. 'cluster', 'project'. Empty means offering-wide.
scope_type_label string Human-readable label for scope_type shown to end users, e.g. 'Rancher Project', 'Cluster Namespace'. Falls back to capitalized scope_type if empty.

200 -

Field Type Description
name string
uuid string (uuid)
offering string (uri)
offering_uuid string (uuid)
offering_name string
scope_type string Level this role applies at, e.g. 'cluster', 'project'. Empty means offering-wide.
scope_type_label string Human-readable label for scope_type shown to end users, e.g. 'Rancher Project', 'Cluster Namespace'. Falls back to capitalized scope_type if empty.

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/marketplace-offering-user-roles/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_offering_user_role_request import PatchedOfferingUserRoleRequest # (1)
from waldur_api_client.api.marketplace_offering_user_roles import marketplace_offering_user_roles_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedOfferingUserRoleRequest()
response = marketplace_offering_user_roles_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedOfferingUserRoleRequest
  2. API Source: marketplace_offering_user_roles_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceOfferingUserRolesPartialUpdate } from 'waldur-js-client';

try {
  const response = await marketplaceOfferingUserRolesPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
name string
offering string (uri)
scope_type string Level this role applies at, e.g. 'cluster', 'project'. Empty means offering-wide.
scope_type_label string Human-readable label for scope_type shown to end users, e.g. 'Rancher Project', 'Cluster Namespace'. Falls back to capitalized scope_type if empty.

200 -

Field Type Description
name string
uuid string (uuid)
offering string (uri)
offering_uuid string (uuid)
offering_name string
scope_type string Level this role applies at, e.g. 'cluster', 'project'. Empty means offering-wide.
scope_type_label string Human-readable label for scope_type shown to end users, e.g. 'Rancher Project', 'Cluster Namespace'. Falls back to capitalized scope_type if empty.

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/marketplace-offering-user-roles/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_offering_user_roles import marketplace_offering_user_roles_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_offering_user_roles_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_offering_user_roles_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceOfferingUserRolesDestroy } from 'waldur-js-client';

try {
  const response = await marketplaceOfferingUserRolesDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Marketplace Offering Users

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/marketplace-offering-users/ List offering users
GET /api/marketplace-offering-users/{uuid}/ Retrieve an offering user
POST /api/marketplace-offering-users/ Create an offering user
POST /api/marketplace-offering-users/{uuid}/update_restricted/ Update restriction status
PUT /api/marketplace-offering-users/{uuid}/ Update
PATCH /api/marketplace-offering-users/{uuid}/ Partial Update
PATCH /api/marketplace-offering-users/{uuid}/update_comments/ Update service provider comments
DELETE /api/marketplace-offering-users/{uuid}/ Delete an offering user
Other Actions
GET /api/marketplace-offering-users/{uuid}/checklist/ Get checklist with questions and existing answers
GET /api/marketplace-offering-users/{uuid}/checklist_review/ Checklist review
GET /api/marketplace-offering-users/checklist-template/ Get checklist template for creating new objects
GET /api/marketplace-offering-users/{uuid}/completion_review_status/ Get checklist completion status with review triggers (reviewers only)
GET /api/marketplace-offering-users/{uuid}/completion_status/ Get checklist completion status
GET /api/marketplace-offering-users/profile_field_warnings/ Get profile field warnings
POST /api/marketplace-offering-users/{uuid}/begin_creating/ Begin creation process
POST /api/marketplace-offering-users/{uuid}/request_deletion/ Request deletion of an offering user
POST /api/marketplace-offering-users/{uuid}/set_deleted/ Set state to Deleted
POST /api/marketplace-offering-users/{uuid}/set_deleting/ Begin deletion process
POST /api/marketplace-offering-users/{uuid}/set_error_creating/ Set state to Error Creating
POST /api/marketplace-offering-users/{uuid}/set_error_deleting/ Set state to Error Deleting
POST /api/marketplace-offering-users/{uuid}/set_ok/ Set state to OK
POST /api/marketplace-offering-users/{uuid}/set_pending_account_linking/ Set state to Pending Account Linking
POST /api/marketplace-offering-users/{uuid}/set_pending_additional_validation/ Set state to Pending Additional Validation
POST /api/marketplace-offering-users/{uuid}/set_validation_complete/ Set state to Validation Complete
POST /api/marketplace-offering-users/{uuid}/submit_answers/ Submit checklist answers

Core CRUD

List offering users

Returns a paginated list of users associated with offerings. The visibility of users depends on the role of the authenticated user. Staff and support can see all users. Service providers can see users of their offerings if the user has consented. Regular users can only see their own offering-user records.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-offering-users/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.offering_user_field_enum import OfferingUserFieldEnum # (1)
from waldur_api_client.models.offering_user_o_enum import OfferingUserOEnum # (2)
from waldur_api_client.models.offering_user_state import OfferingUserState # (3)
from waldur_api_client.api.marketplace_offering_users import marketplace_offering_users_list # (4)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_offering_users_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: OfferingUserFieldEnum
  2. Model Source: OfferingUserOEnum
  3. Model Source: OfferingUserState
  4. API Source: marketplace_offering_users_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceOfferingUsersList } from 'waldur-js-client';

try {
  const response = await marketplaceOfferingUsersList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
created string (date-time) Created after
field array
has_complete_profile boolean User has complete profile for the offering
has_consent boolean User Has Consent
is_restricted boolean Is restricted
modified string (date-time) Modified after
o array Ordering
offering string (uri)
offering_slug array Multiple values may be separated by commas.
offering_uuid array Multiple values may be separated by commas.
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
parent_offering_uuid string (uuid)
provider_uuid string (uuid) Provider UUID
query string Search by offering name, username or user name
state array Offering user state
user_username string User username
user_uuid string (uuid) User UUID

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
user string (uri)
offering string (uri)
username string
offering_uuid string (uuid)
offering_name string
user_uuid string (uuid)
user_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
user_full_name string
user_first_name string
user_last_name string
user_email string (email)
user_phone_number string
user_organization string
user_job_title string
user_affiliations any Person's affiliation within organization such as student, faculty, staff.
user_gender any ISO 5218 gender code
user_personal_title string Honorific title (Mr, Ms, Dr, Prof, etc.)
user_place_of_birth string
user_country_of_residence string
user_nationality string Primary citizenship (ISO 3166-1 alpha-2 code)
user_nationalities any List of all citizenships (ISO 3166-1 alpha-2 codes)
user_organization_country string
user_organization_type string SCHAC URN (e.g., urn:schac:homeOrganizationType:int:university)
user_organization_registry_code string Company registration code of the user's organization, if known
user_eduperson_assurance any REFEDS assurance profile URIs from identity provider
user_civil_number string
user_birth_date string (date)
user_identity_source string Indicates what identity provider was used.
user_active_isds any List of ISDs that have asserted this user exists. User is deactivated when this becomes empty.
created string (date-time)
modified string (date-time)
customer_uuid string (uuid)
customer_name string
is_restricted boolean Signal to service if the user account is restricted or not
state any
service_provider_comment string Additional comment for pending states like validation or account linking
service_provider_comment_url string (uri) URL link for additional information or actions related to service provider comment
has_consent boolean Check if the user has active consent for this offering.
requires_reconsent boolean Check if the user needs to re-consent due to ToS changes.
has_compliance_checklist boolean Check if the offering user has a connected compliance checklist completion.
consent_data object (free-form) User consent data including uuid, version, and agreement_date
is_profile_complete boolean
missing_profile_attributes array of strings

Retrieve an offering user

Returns the details of a specific offering-user link. Visibility follows the same rules as the list view.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-offering-users/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.offering_user_field_enum import OfferingUserFieldEnum # (1)
from waldur_api_client.api.marketplace_offering_users import marketplace_offering_users_retrieve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_offering_users_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. Model Source: OfferingUserFieldEnum
  2. API Source: marketplace_offering_users_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceOfferingUsersRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceOfferingUsersRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type
field array

200 -

Field Type Description
url string (uri)
uuid string (uuid)
user string (uri)
offering string (uri)
username string
offering_uuid string (uuid)
offering_name string
user_uuid string (uuid)
user_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
user_full_name string
user_first_name string
user_last_name string
user_email string (email)
user_phone_number string
user_organization string
user_job_title string
user_affiliations any Person's affiliation within organization such as student, faculty, staff.
user_gender any ISO 5218 gender code
user_personal_title string Honorific title (Mr, Ms, Dr, Prof, etc.)
user_place_of_birth string
user_country_of_residence string
user_nationality string Primary citizenship (ISO 3166-1 alpha-2 code)
user_nationalities any List of all citizenships (ISO 3166-1 alpha-2 codes)
user_organization_country string
user_organization_type string SCHAC URN (e.g., urn:schac:homeOrganizationType:int:university)
user_organization_registry_code string Company registration code of the user's organization, if known
user_eduperson_assurance any REFEDS assurance profile URIs from identity provider
user_civil_number string
user_birth_date string (date)
user_identity_source string Indicates what identity provider was used.
user_active_isds any List of ISDs that have asserted this user exists. User is deactivated when this becomes empty.
created string (date-time)
modified string (date-time)
customer_uuid string (uuid)
customer_name string
is_restricted boolean Signal to service if the user account is restricted or not
state any
service_provider_comment string Additional comment for pending states like validation or account linking
service_provider_comment_url string (uri) URL link for additional information or actions related to service provider comment
has_consent boolean Check if the user has active consent for this offering.
requires_reconsent boolean Check if the user needs to re-consent due to ToS changes.
has_compliance_checklist boolean Check if the offering user has a connected compliance checklist completion.
consent_data object (free-form) User consent data including uuid, version, and agreement_date
is_profile_complete boolean
missing_profile_attributes array of strings

Create an offering user

Associates a user with a specific offering, creating an offering-specific user account. This is typically done by a service provider.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-offering-users/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.offering_user_request import OfferingUserRequest # (1)
from waldur_api_client.api.marketplace_offering_users import marketplace_offering_users_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OfferingUserRequest()
response = marketplace_offering_users_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OfferingUserRequest
  2. API Source: marketplace_offering_users_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceOfferingUsersCreate } from 'waldur-js-client';

try {
  const response = await marketplaceOfferingUsersCreate({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required
user string (uri)
offering string (uri)
username string
offering_uuid string (uuid)
user_uuid string (uuid)

201 -

Field Type Description
url string (uri)
uuid string (uuid)
user string (uri)
offering string (uri)
username string
offering_uuid string (uuid)
offering_name string
user_uuid string (uuid)
user_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
user_full_name string
user_first_name string
user_last_name string
user_email string (email)
user_phone_number string
user_organization string
user_job_title string
user_affiliations any Person's affiliation within organization such as student, faculty, staff.
user_gender any ISO 5218 gender code
user_personal_title string Honorific title (Mr, Ms, Dr, Prof, etc.)
user_place_of_birth string
user_country_of_residence string
user_nationality string Primary citizenship (ISO 3166-1 alpha-2 code)
user_nationalities any List of all citizenships (ISO 3166-1 alpha-2 codes)
user_organization_country string
user_organization_type string SCHAC URN (e.g., urn:schac:homeOrganizationType:int:university)
user_organization_registry_code string Company registration code of the user's organization, if known
user_eduperson_assurance any REFEDS assurance profile URIs from identity provider
user_civil_number string
user_birth_date string (date)
user_identity_source string Indicates what identity provider was used.
user_active_isds any List of ISDs that have asserted this user exists. User is deactivated when this becomes empty.
created string (date-time)
modified string (date-time)
customer_uuid string (uuid)
customer_name string
is_restricted boolean Signal to service if the user account is restricted or not
state any
service_provider_comment string Additional comment for pending states like validation or account linking
service_provider_comment_url string (uri) URL link for additional information or actions related to service provider comment
has_consent boolean Check if the user has active consent for this offering.
requires_reconsent boolean Check if the user needs to re-consent due to ToS changes.
has_compliance_checklist boolean Check if the offering user has a connected compliance checklist completion.
consent_data object (free-form) User consent data including uuid, version, and agreement_date
is_profile_complete boolean
missing_profile_attributes array of strings

Update restriction status

Allows a service provider to mark an offering user as restricted or unrestricted. A restricted user may have limited access to the resource.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/marketplace-offering-users/a1b2c3d4-e5f6-7890-abcd-ef1234567890/update_restricted/ \
  Authorization:"Token YOUR_API_TOKEN" \
  is_restricted=true

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.offering_user_update_restriction_request import OfferingUserUpdateRestrictionRequest # (1)
from waldur_api_client.api.marketplace_offering_users import marketplace_offering_users_update_restricted # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OfferingUserUpdateRestrictionRequest(
    is_restricted=true
)
response = marketplace_offering_users_update_restricted.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OfferingUserUpdateRestrictionRequest
  2. API Source: marketplace_offering_users_update_restricted
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { marketplaceOfferingUsersUpdateRestricted } from 'waldur-js-client';

try {
  const response = await marketplaceOfferingUsersUpdateRestricted({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "is_restricted": true
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
is_restricted boolean ✓ Whether the offering user should be restricted from accessing resources

200 - No response body

Update

1
2
3
4
http \
  PUT \
  https://api.example.com/api/marketplace-offering-users/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.offering_user_request import OfferingUserRequest # (1)
from waldur_api_client.api.marketplace_offering_users import marketplace_offering_users_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OfferingUserRequest()
response = marketplace_offering_users_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OfferingUserRequest
  2. API Source: marketplace_offering_users_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceOfferingUsersUpdate } from 'waldur-js-client';

try {
  const response = await marketplaceOfferingUsersUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
user string (uri)
offering string (uri)
username string
offering_uuid string (uuid)
user_uuid string (uuid)

200 -

Field Type Description
url string (uri)
uuid string (uuid)
user string (uri)
offering string (uri)
username string
offering_uuid string (uuid)
offering_name string
user_uuid string (uuid)
user_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
user_full_name string
user_first_name string
user_last_name string
user_email string (email)
user_phone_number string
user_organization string
user_job_title string
user_affiliations any Person's affiliation within organization such as student, faculty, staff.
user_gender any ISO 5218 gender code
user_personal_title string Honorific title (Mr, Ms, Dr, Prof, etc.)
user_place_of_birth string
user_country_of_residence string
user_nationality string Primary citizenship (ISO 3166-1 alpha-2 code)
user_nationalities any List of all citizenships (ISO 3166-1 alpha-2 codes)
user_organization_country string
user_organization_type string SCHAC URN (e.g., urn:schac:homeOrganizationType:int:university)
user_organization_registry_code string Company registration code of the user's organization, if known
user_eduperson_assurance any REFEDS assurance profile URIs from identity provider
user_civil_number string
user_birth_date string (date)
user_identity_source string Indicates what identity provider was used.
user_active_isds any List of ISDs that have asserted this user exists. User is deactivated when this becomes empty.
created string (date-time)
modified string (date-time)
customer_uuid string (uuid)
customer_name string
is_restricted boolean Signal to service if the user account is restricted or not
state any
service_provider_comment string Additional comment for pending states like validation or account linking
service_provider_comment_url string (uri) URL link for additional information or actions related to service provider comment
has_consent boolean Check if the user has active consent for this offering.
requires_reconsent boolean Check if the user needs to re-consent due to ToS changes.
has_compliance_checklist boolean Check if the offering user has a connected compliance checklist completion.
consent_data object (free-form) User consent data including uuid, version, and agreement_date
is_profile_complete boolean
missing_profile_attributes array of strings

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/marketplace-offering-users/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_offering_user_request import PatchedOfferingUserRequest # (1)
from waldur_api_client.api.marketplace_offering_users import marketplace_offering_users_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedOfferingUserRequest()
response = marketplace_offering_users_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedOfferingUserRequest
  2. API Source: marketplace_offering_users_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceOfferingUsersPartialUpdate } from 'waldur-js-client';

try {
  const response = await marketplaceOfferingUsersPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
user string (uri)
offering string (uri)
username string
offering_uuid string (uuid)
user_uuid string (uuid)

200 -

Field Type Description
url string (uri)
uuid string (uuid)
user string (uri)
offering string (uri)
username string
offering_uuid string (uuid)
offering_name string
user_uuid string (uuid)
user_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
user_full_name string
user_first_name string
user_last_name string
user_email string (email)
user_phone_number string
user_organization string
user_job_title string
user_affiliations any Person's affiliation within organization such as student, faculty, staff.
user_gender any ISO 5218 gender code
user_personal_title string Honorific title (Mr, Ms, Dr, Prof, etc.)
user_place_of_birth string
user_country_of_residence string
user_nationality string Primary citizenship (ISO 3166-1 alpha-2 code)
user_nationalities any List of all citizenships (ISO 3166-1 alpha-2 codes)
user_organization_country string
user_organization_type string SCHAC URN (e.g., urn:schac:homeOrganizationType:int:university)
user_organization_registry_code string Company registration code of the user's organization, if known
user_eduperson_assurance any REFEDS assurance profile URIs from identity provider
user_civil_number string
user_birth_date string (date)
user_identity_source string Indicates what identity provider was used.
user_active_isds any List of ISDs that have asserted this user exists. User is deactivated when this becomes empty.
created string (date-time)
modified string (date-time)
customer_uuid string (uuid)
customer_name string
is_restricted boolean Signal to service if the user account is restricted or not
state any
service_provider_comment string Additional comment for pending states like validation or account linking
service_provider_comment_url string (uri) URL link for additional information or actions related to service provider comment
has_consent boolean Check if the user has active consent for this offering.
requires_reconsent boolean Check if the user needs to re-consent due to ToS changes.
has_compliance_checklist boolean Check if the offering user has a connected compliance checklist completion.
consent_data object (free-form) User consent data including uuid, version, and agreement_date
is_profile_complete boolean
missing_profile_attributes array of strings

Update service provider comments

Allows a service provider to update the service_provider_comment and service_provider_comment_url fields for an offering user. This is often used to provide feedback or instructions during a pending state.

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/marketplace-offering-users/a1b2c3d4-e5f6-7890-abcd-ef1234567890/update_comments/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_offering_user_service_provider_comment_request import PatchedOfferingUserServiceProviderCommentRequest # (1)
from waldur_api_client.api.marketplace_offering_users import marketplace_offering_users_update_comments_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedOfferingUserServiceProviderCommentRequest()
response = marketplace_offering_users_update_comments_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedOfferingUserServiceProviderCommentRequest
  2. API Source: marketplace_offering_users_update_comments_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceOfferingUsersUpdateCommentsPartialUpdate } from 'waldur-js-client';

try {
  const response = await marketplaceOfferingUsersUpdateCommentsPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
service_provider_comment string
service_provider_comment_url string (uri) URL link for additional information or actions related to service provider comment

200 -

Field Type Description
service_provider_comment string
service_provider_comment_url string (uri) URL link for additional information or actions related to service provider comment

Delete an offering user

Removes the association between a user and an offering. This action may trigger backend cleanup processes depending on the offering type.

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/marketplace-offering-users/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_offering_users import marketplace_offering_users_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_offering_users_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_offering_users_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceOfferingUsersDestroy } from 'waldur-js-client';

try {
  const response = await marketplaceOfferingUsersDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Other Actions

Get checklist with questions and existing answers

Get checklist with questions and existing answers.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-offering-users/a1b2c3d4-e5f6-7890-abcd-ef1234567890/checklist/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_offering_users import marketplace_offering_users_checklist_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_offering_users_checklist_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_offering_users_checklist_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceOfferingUsersChecklistRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceOfferingUsersChecklistRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type Description
include_all boolean If true, returns all questions including hidden ones (for dynamic form visibility). Default: false.

200 -

Field Type Description
checklist object (free-form)
completion object
completion.uuid string (uuid)
completion.is_completed boolean Whether all required questions have been answered
completion.completion_percentage number (double)
completion.unanswered_required_questions array of anys
completion.checklist_name string
completion.checklist_description string
completion.created string (date-time)
completion.modified string (date-time)
questions array of objects
questions.uuid string (uuid)
questions.description string
questions.user_guidance string
questions.question_type any Type of question and expected answer format
questions.required boolean
questions.order integer
questions.existing_answer object (free-form)
questions.question_options array of anys
questions.min_value string (decimal) Minimum value allowed for NUMBER, YEAR, and RATING type questions
questions.max_value string (decimal) Maximum value allowed for NUMBER, YEAR, and RATING type questions
questions.allowed_file_types any List of allowed file extensions (e.g., ['.pdf', '.doc', '.docx']). If empty, all file types are allowed.
questions.allowed_mime_types any List of allowed MIME types (e.g., ['application/pdf', 'application/msword']). If empty, MIME type validation is not enforced. When both extensions and MIME types are specified, files must match both criteria for security.
questions.max_file_size_mb integer Maximum file size in megabytes. If not set, no size limit is enforced.
questions.max_files_count integer Maximum number of files allowed for MULTIPLE_FILES type questions. If not set, no count limit is enforced.
questions.dependencies_info object (free-form)

400 -

404 -

Checklist review

Get checklist with questions and existing answers including review logic (reviewers only).

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-offering-users/a1b2c3d4-e5f6-7890-abcd-ef1234567890/checklist_review/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_offering_users import marketplace_offering_users_checklist_review_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_offering_users_checklist_review_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_offering_users_checklist_review_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceOfferingUsersChecklistReviewRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceOfferingUsersChecklistReviewRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
checklist object (free-form)
completion object
completion.uuid string (uuid)
completion.is_completed boolean Whether all required questions have been answered
completion.completion_percentage number (double)
completion.unanswered_required_questions array of anys
completion.checklist_name string
completion.checklist_description string
completion.created string (date-time)
completion.modified string (date-time)
completion.requires_review boolean Whether any answers triggered review requirements
completion.reviewed_by integer User who reviewed the checklist completion
completion.reviewed_by_name string
completion.reviewed_at string (date-time)
completion.review_notes string Notes from the reviewer
completion.review_trigger_summary array of anys
questions array of objects
questions.uuid string (uuid)
questions.description string
questions.user_guidance string
questions.question_type any Type of question and expected answer format
questions.required boolean
questions.order integer
questions.existing_answer object (free-form)
questions.question_options array of anys
questions.min_value string (decimal) Minimum value allowed for NUMBER, YEAR, and RATING type questions
questions.max_value string (decimal) Maximum value allowed for NUMBER, YEAR, and RATING type questions
questions.allowed_file_types any List of allowed file extensions (e.g., ['.pdf', '.doc', '.docx']). If empty, all file types are allowed.
questions.allowed_mime_types any List of allowed MIME types (e.g., ['application/pdf', 'application/msword']). If empty, MIME type validation is not enforced. When both extensions and MIME types are specified, files must match both criteria for security.
questions.max_file_size_mb integer Maximum file size in megabytes. If not set, no size limit is enforced.
questions.max_files_count integer Maximum number of files allowed for MULTIPLE_FILES type questions. If not set, no count limit is enforced.
questions.dependencies_info object (free-form)
questions.operator any
questions.review_answer_value any Answer value that trigger review.
questions.always_requires_review boolean This question always requires review regardless of answer

400 -

404 -

Get checklist template for creating new objects

Get checklist template for creating new objects.

1
2
3
4
5
http \
  GET \
  https://api.example.com/api/marketplace-offering-users/checklist-template/ \
  Authorization:"Token YOUR_API_TOKEN" \
  parent_uuid=="a1b2c3d4-e5f6-7890-abcd-ef1234567890"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_offering_users import marketplace_offering_users_checklist_template_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_offering_users_checklist_template_retrieve.sync(
    client=client,
    parent_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
)

print(response)
  1. API Source: marketplace_offering_users_checklist_template_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceOfferingUsersChecklistTemplateRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceOfferingUsersChecklistTemplateRetrieve({
  auth: "Token YOUR_API_TOKEN",
  query: {
    "parent_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
parent_uuid string (uuid) ✓ UUID of the parent object (e.g., customer UUID for new projects)

200 -

Field Type Description
checklist object (free-form)
questions array of objects
questions.uuid string (uuid)
questions.required boolean
questions.description string
questions.user_guidance string Additional guidance text visible to users when answering and reviewing
questions.question_options array of objects
questions.question_options.uuid string (uuid)
questions.question_options.label string
questions.question_options.order integer
questions.question_type any Type of question and expected answer format
questions.order integer
questions.min_value string (decimal) Minimum value allowed for NUMBER, YEAR, and RATING type questions
questions.max_value string (decimal) Maximum value allowed for NUMBER, YEAR, and RATING type questions
questions.allowed_file_types any List of allowed file extensions (e.g., ['.pdf', '.doc', '.docx']). If empty, all file types are allowed.
questions.allowed_mime_types any List of allowed MIME types (e.g., ['application/pdf', 'application/msword']). If empty, MIME type validation is not enforced. When both extensions and MIME types are specified, files must match both criteria for security.
questions.max_file_size_mb integer Maximum file size in megabytes. If not set, no size limit is enforced.
questions.max_files_count integer Maximum number of files allowed for MULTIPLE_FILES type questions. If not set, no count limit is enforced.
questions.operator any
questions.review_answer_value any Answer value that trigger review.
questions.always_requires_review boolean This question always requires review regardless of answer
questions.guidance_answer_value any Answer value that triggers display of user guidance.
questions.guidance_operator any Operator to use when comparing answer with guidance_answer_value
questions.always_show_guidance boolean Show user guidance always, regardless of answer. If False, guidance is conditional on answer matching guidance_answer_value with guidance_operator
questions.dependency_logic_operator any Defines how multiple dependencies are evaluated. AND: All dependencies must be satisfied. OR: At least one dependency must be satisfied.
initial_visible_questions array of objects
initial_visible_questions.uuid string (uuid)
initial_visible_questions.required boolean
initial_visible_questions.description string
initial_visible_questions.user_guidance string Additional guidance text visible to users when answering and reviewing
initial_visible_questions.question_options array of objects
initial_visible_questions.question_options.uuid string (uuid)
initial_visible_questions.question_options.label string
initial_visible_questions.question_options.order integer
initial_visible_questions.question_type any Type of question and expected answer format
initial_visible_questions.order integer
initial_visible_questions.min_value string (decimal) Minimum value allowed for NUMBER, YEAR, and RATING type questions
initial_visible_questions.max_value string (decimal) Maximum value allowed for NUMBER, YEAR, and RATING type questions
initial_visible_questions.allowed_file_types any List of allowed file extensions (e.g., ['.pdf', '.doc', '.docx']). If empty, all file types are allowed.
initial_visible_questions.allowed_mime_types any List of allowed MIME types (e.g., ['application/pdf', 'application/msword']). If empty, MIME type validation is not enforced. When both extensions and MIME types are specified, files must match both criteria for security.
initial_visible_questions.max_file_size_mb integer Maximum file size in megabytes. If not set, no size limit is enforced.
initial_visible_questions.max_files_count integer Maximum number of files allowed for MULTIPLE_FILES type questions. If not set, no count limit is enforced.
initial_visible_questions.operator any
initial_visible_questions.review_answer_value any Answer value that trigger review.
initial_visible_questions.always_requires_review boolean This question always requires review regardless of answer
initial_visible_questions.guidance_answer_value any Answer value that triggers display of user guidance.
initial_visible_questions.guidance_operator any Operator to use when comparing answer with guidance_answer_value
initial_visible_questions.always_show_guidance boolean Show user guidance always, regardless of answer. If False, guidance is conditional on answer matching guidance_answer_value with guidance_operator
initial_visible_questions.dependency_logic_operator any Defines how multiple dependencies are evaluated. AND: All dependencies must be satisfied. OR: At least one dependency must be satisfied.

400 -

404 -

Get checklist completion status with review triggers (reviewers only)

Get checklist completion status with review triggers (reviewers only).

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-offering-users/a1b2c3d4-e5f6-7890-abcd-ef1234567890/completion_review_status/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_offering_users import marketplace_offering_users_completion_review_status_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_offering_users_completion_review_status_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_offering_users_completion_review_status_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceOfferingUsersCompletionReviewStatusRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceOfferingUsersCompletionReviewStatusRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
uuid string (uuid)
is_completed boolean Whether all required questions have been answered
completion_percentage number (double)
unanswered_required_questions array of anys
checklist_name string
checklist_description string
created string (date-time)
modified string (date-time)
requires_review boolean Whether any answers triggered review requirements
reviewed_by integer User who reviewed the checklist completion
reviewed_by_name string
reviewed_at string (date-time)
review_notes string Notes from the reviewer
review_trigger_summary array of anys

400 -

404 -

Get checklist completion status

Get checklist completion status.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-offering-users/a1b2c3d4-e5f6-7890-abcd-ef1234567890/completion_status/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_offering_users import marketplace_offering_users_completion_status_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_offering_users_completion_status_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_offering_users_completion_status_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceOfferingUsersCompletionStatusRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceOfferingUsersCompletionStatusRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
uuid string (uuid)
is_completed boolean Whether all required questions have been answered
completion_percentage number (double)
unanswered_required_questions array of anys
checklist_name string
checklist_description string
created string (date-time)
modified string (date-time)

400 -

404 -

Get profile field warnings

Returns a mapping of user profile field names to offerings that expose those fields. When ENFORCE_OFFERING_USER_PROFILE_COMPLETENESS is enabled, clearing a field listed here would make the user invisible to the service provider for the associated offerings.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-offering-users/profile_field_warnings/ \
  Authorization:"Token YOUR_API_TOKEN"

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_offering_users import marketplace_offering_users_profile_field_warnings_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_offering_users_profile_field_warnings_retrieve.sync(client=client)

print(response)
  1. API Source: marketplace_offering_users_profile_field_warnings_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceOfferingUsersProfileFieldWarningsRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceOfferingUsersProfileFieldWarningsRetrieve({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

200 - No response body

Begin creation process

Transitions the offering user state from 'Requested' or 'Error Creating' to 'Creating'. This is typically used by an agent to signal that the creation process has started.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-offering-users/a1b2c3d4-e5f6-7890-abcd-ef1234567890/begin_creating/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_offering_users import marketplace_offering_users_begin_creating # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_offering_users_begin_creating.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_offering_users_begin_creating
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceOfferingUsersBeginCreating } from 'waldur-js-client';

try {
  const response = await marketplaceOfferingUsersBeginCreating({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 - No response body

Request deletion of an offering user

Initiates the deletion process for an offering user account by transitioning it to the 'Deletion Requested' state.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-offering-users/a1b2c3d4-e5f6-7890-abcd-ef1234567890/request_deletion/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_offering_users import marketplace_offering_users_request_deletion # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_offering_users_request_deletion.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_offering_users_request_deletion
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceOfferingUsersRequestDeletion } from 'waldur-js-client';

try {
  const response = await marketplaceOfferingUsersRequestDeletion({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 - No response body

Set state to Deleted

Transitions the offering user to the 'Deleted' state, marking the successful completion of the deletion process.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-offering-users/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_deleted/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_offering_users import marketplace_offering_users_set_deleted # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_offering_users_set_deleted.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_offering_users_set_deleted
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceOfferingUsersSetDeleted } from 'waldur-js-client';

try {
  const response = await marketplaceOfferingUsersSetDeleted({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 - No response body

Begin deletion process

Transitions the offering user to the 'Deleting' state. This is typically used by an agent to signal that the deletion process has started.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-offering-users/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_deleting/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_offering_users import marketplace_offering_users_set_deleting # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_offering_users_set_deleting.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_offering_users_set_deleting
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceOfferingUsersSetDeleting } from 'waldur-js-client';

try {
  const response = await marketplaceOfferingUsersSetDeleting({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 - No response body

Set state to Error Creating

Manually moves the offering user into the 'Error Creating' state. This is typically used by an agent to report a failure during the creation process.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-offering-users/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_error_creating/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_offering_users import marketplace_offering_users_set_error_creating # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_offering_users_set_error_creating.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_offering_users_set_error_creating
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceOfferingUsersSetErrorCreating } from 'waldur-js-client';

try {
  const response = await marketplaceOfferingUsersSetErrorCreating({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 - No response body

Set state to Error Deleting

Manually moves the offering user into the 'Error Deleting' state. This is typically used by an agent to report a failure during the deletion process.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-offering-users/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_error_deleting/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_offering_users import marketplace_offering_users_set_error_deleting # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_offering_users_set_error_deleting.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_offering_users_set_error_deleting
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceOfferingUsersSetErrorDeleting } from 'waldur-js-client';

try {
  const response = await marketplaceOfferingUsersSetErrorDeleting({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 - No response body

Set state to OK

Manually sets the offering user state to 'OK'. This can be used to recover from an error state or to complete a manual creation process.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-offering-users/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_ok/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_offering_users import marketplace_offering_users_set_ok # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_offering_users_set_ok.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_offering_users_set_ok
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceOfferingUsersSetOk } from 'waldur-js-client';

try {
  const response = await marketplaceOfferingUsersSetOk({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 - No response body

Set state to Pending Account Linking

Transitions the state to 'Pending Account Linking' and allows a service provider to add a comment and a URL to guide the user.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-offering-users/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_pending_account_linking/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.offering_user_state_transition_request import OfferingUserStateTransitionRequest # (1)
from waldur_api_client.api.marketplace_offering_users import marketplace_offering_users_set_pending_account_linking # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OfferingUserStateTransitionRequest()
response = marketplace_offering_users_set_pending_account_linking.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OfferingUserStateTransitionRequest
  2. API Source: marketplace_offering_users_set_pending_account_linking
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceOfferingUsersSetPendingAccountLinking } from 'waldur-js-client';

try {
  const response = await marketplaceOfferingUsersSetPendingAccountLinking({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
comment string Comment explaining the state transition
comment_url string (uri) URL reference related to the state transition comment

200 - No response body

Set state to Pending Additional Validation

Transitions the state to 'Pending Additional Validation' and allows a service provider to add a comment and a URL for the user to follow.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-offering-users/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_pending_additional_validation/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.offering_user_state_transition_request import OfferingUserStateTransitionRequest # (1)
from waldur_api_client.api.marketplace_offering_users import marketplace_offering_users_set_pending_additional_validation # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OfferingUserStateTransitionRequest()
response = marketplace_offering_users_set_pending_additional_validation.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OfferingUserStateTransitionRequest
  2. API Source: marketplace_offering_users_set_pending_additional_validation
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceOfferingUsersSetPendingAdditionalValidation } from 'waldur-js-client';

try {
  const response = await marketplaceOfferingUsersSetPendingAdditionalValidation({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
comment string Comment explaining the state transition
comment_url string (uri) URL reference related to the state transition comment

200 - No response body

Set state to Validation Complete

Transitions the state from a pending validation state to 'OK', indicating that the user has completed the required steps. This clears any service provider comments.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-offering-users/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_validation_complete/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_offering_users import marketplace_offering_users_set_validation_complete # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_offering_users_set_validation_complete.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_offering_users_set_validation_complete
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceOfferingUsersSetValidationComplete } from 'waldur-js-client';

try {
  const response = await marketplaceOfferingUsersSetValidationComplete({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 - No response body

Submit checklist answers

Submit checklist answers.

1
2
3
4
echo '[{"question_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "answer_data": null}]' | http \
  POST \
  https://api.example.com/api/marketplace-offering-users/a1b2c3d4-e5f6-7890-abcd-ef1234567890/submit_answers/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_offering_users import marketplace_offering_users_submit_answers # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_offering_users_submit_answers.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_offering_users_submit_answers
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { marketplaceOfferingUsersSubmitAnswers } from 'waldur-js-client';

try {
  const response = await marketplaceOfferingUsersSubmitAnswers({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: [{"question_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "answer_data": null}]
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

The request body is an array of objects, where each object has the following structure:

Field Type Required
question_uuid string (uuid) ✓
answer_data any ✓

200 -

Field Type Description
detail string
completion object
completion.uuid string (uuid)
completion.is_completed boolean Whether all required questions have been answered
completion.completion_percentage number (double)
completion.unanswered_required_questions array of anys
completion.checklist_name string
completion.checklist_description string
completion.created string (date-time)
completion.modified string (date-time)

400 -

404 -

Marketplace Project Service Accounts

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/marketplace-project-service-accounts/ List service accounts
GET /api/marketplace-project-service-accounts/{uuid}/ Retrieve a service account
POST /api/marketplace-project-service-accounts/ Create a project service account
PUT /api/marketplace-project-service-accounts/{uuid}/ Update a service account
PATCH /api/marketplace-project-service-accounts/{uuid}/ Partially update a service account
DELETE /api/marketplace-project-service-accounts/{uuid}/ Close a project service account
Other Actions
POST /api/marketplace-project-service-accounts/{uuid}/rotate_api_key/ Rotate API key for a project service account

Core CRUD

List service accounts

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-project-service-accounts/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.service_account_state import ServiceAccountState # (1)
from waldur_api_client.api.marketplace_project_service_accounts import marketplace_project_service_accounts_list # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_project_service_accounts_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: ServiceAccountState
  2. API Source: marketplace_project_service_accounts_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceProjectServiceAccountsList } from 'waldur-js-client';

try {
  const response = await marketplaceProjectServiceAccountsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
email string Email contains
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
project string (uri) Project URL
project_uuid string (uuid) Project UUID
state array Service account state
username string Username

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
url string (uri)
uuid string (uuid)
created string (date-time)
modified string (date-time)
username string
description string
error_message string
error_traceback string
state any
token string
email string (email)
expires_at string
preferred_identifier string
project string (uuid)
project_uuid string (uuid)
project_name string
customer_uuid string (uuid)
customer_name string
customer_abbreviation string

Retrieve a service account

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-project-service-accounts/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_project_service_accounts import marketplace_project_service_accounts_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_project_service_accounts_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_project_service_accounts_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceProjectServiceAccountsRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceProjectServiceAccountsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
url string (uri)
uuid string (uuid)
created string (date-time)
modified string (date-time)
username string
description string
error_message string
error_traceback string
state any
token string
email string (email)
expires_at string
preferred_identifier string
project string (uuid)
project_uuid string (uuid)
project_name string
customer_uuid string (uuid)
customer_name string
customer_abbreviation string

Create a project service account

Creates a new service account scoped to a specific project. This generates an API key that can be used for automated access to resources within that project.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/marketplace-project-service-accounts/ \
  Authorization:"Token YOUR_API_TOKEN" \
  project="a1b2c3d4-e5f6-7890-abcd-ef1234567890"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.project_service_account_request import ProjectServiceAccountRequest # (1)
from waldur_api_client.api.marketplace_project_service_accounts import marketplace_project_service_accounts_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ProjectServiceAccountRequest(
    project="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
)
response = marketplace_project_service_accounts_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ProjectServiceAccountRequest
  2. API Source: marketplace_project_service_accounts_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceProjectServiceAccountsCreate } from 'waldur-js-client';

try {
  const response = await marketplaceProjectServiceAccountsCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "project": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required
username string
description string
error_traceback string
email string (email)
preferred_identifier string
project string (uuid) ✓

201 -

Field Type
url string (uri)
uuid string (uuid)
created string (date-time)
modified string (date-time)
username string
description string
error_message string
error_traceback string
state any
token string
email string (email)
expires_at string
preferred_identifier string
project string (uuid)
project_uuid string (uuid)
project_name string
customer_uuid string (uuid)
customer_name string
customer_abbreviation string

Update a service account

1
2
3
4
5
http \
  PUT \
  https://api.example.com/api/marketplace-project-service-accounts/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  project="a1b2c3d4-e5f6-7890-abcd-ef1234567890"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.project_service_account_request import ProjectServiceAccountRequest # (1)
from waldur_api_client.api.marketplace_project_service_accounts import marketplace_project_service_accounts_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ProjectServiceAccountRequest(
    project="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
)
response = marketplace_project_service_accounts_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ProjectServiceAccountRequest
  2. API Source: marketplace_project_service_accounts_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { marketplaceProjectServiceAccountsUpdate } from 'waldur-js-client';

try {
  const response = await marketplaceProjectServiceAccountsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "project": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
username string
description string
error_traceback string
email string (email)
preferred_identifier string
project string (uuid) ✓

200 -

Field Type
url string (uri)
uuid string (uuid)
created string (date-time)
modified string (date-time)
username string
description string
error_message string
error_traceback string
state any
token string
email string (email)
expires_at string
preferred_identifier string
project string (uuid)
project_uuid string (uuid)
project_name string
customer_uuid string (uuid)
customer_name string
customer_abbreviation string

Partially update a service account

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/marketplace-project-service-accounts/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_project_service_account_request import PatchedProjectServiceAccountRequest # (1)
from waldur_api_client.api.marketplace_project_service_accounts import marketplace_project_service_accounts_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedProjectServiceAccountRequest()
response = marketplace_project_service_accounts_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedProjectServiceAccountRequest
  2. API Source: marketplace_project_service_accounts_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceProjectServiceAccountsPartialUpdate } from 'waldur-js-client';

try {
  const response = await marketplaceProjectServiceAccountsPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
username string
description string
error_traceback string
email string (email)
preferred_identifier string
project string (uuid)

200 -

Field Type
url string (uri)
uuid string (uuid)
created string (date-time)
modified string (date-time)
username string
description string
error_message string
error_traceback string
state any
token string
email string (email)
expires_at string
preferred_identifier string
project string (uuid)
project_uuid string (uuid)
project_name string
customer_uuid string (uuid)
customer_name string
customer_abbreviation string

Close a project service account

Deactivates a project service account and revokes its API key.

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/marketplace-project-service-accounts/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_project_service_accounts import marketplace_project_service_accounts_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_project_service_accounts_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_project_service_accounts_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceProjectServiceAccountsDestroy } from 'waldur-js-client';

try {
  const response = await marketplaceProjectServiceAccountsDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Other Actions

Rotate API key for a project service account

Generates a new API key for the service account, immediately invalidating the old one. The new key is returned in the response.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-project-service-accounts/a1b2c3d4-e5f6-7890-abcd-ef1234567890/rotate_api_key/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_project_service_accounts import marketplace_project_service_accounts_rotate_api_key # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_project_service_accounts_rotate_api_key.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_project_service_accounts_rotate_api_key
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceProjectServiceAccountsRotateApiKey } from 'waldur-js-client';

try {
  const response = await marketplaceProjectServiceAccountsRotateApiKey({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
url string (uri)
uuid string (uuid)
created string (date-time)
modified string (date-time)
username string
description string
error_message string
error_traceback string
state any
token string
email string (email)
expires_at string
preferred_identifier string
project string (uuid)
project_uuid string (uuid)
project_name string
customer_uuid string (uuid)
customer_name string
customer_abbreviation string

Marketplace Resource Users

Operations Summary

Method Endpoint Description
GET /api/marketplace-resource-users/ List resource users
GET /api/marketplace-resource-users/{uuid}/ Retrieve a resource-user link
POST /api/marketplace-resource-users/ Link a user to a resource
DELETE /api/marketplace-resource-users/{uuid}/ Unlink a user from a resource

List resource users

Returns a paginated list of users associated with resources, including their roles. The list is filtered based on the permissions of the current user. Staff and support users can see all resource-user links. Other users can only see links for resources they have access to.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-resource-users/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_resource_users import marketplace_resource_users_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_resource_users_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: marketplace_resource_users_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceResourceUsersList } from 'waldur-js-client';

try {
  const response = await marketplaceResourceUsersList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
resource string (uri) Resource URL
resource_uuid string (uuid) Resource UUID
role_name string Role name
role_uuid string (uuid) Role UUID
user_uuid string (uuid) User UUID

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid)
resource string (uri)
role string (uri)
user string (uri)
resource_uuid string (uuid)
role_uuid string (uuid)
user_uuid string (uuid)
resource_name string
role_name string
user_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
user_full_name string

Returns details of a specific link between a user and a resource, including their role.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-resource-users/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_resource_users import marketplace_resource_users_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_resource_users_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_resource_users_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceResourceUsersRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceResourceUsersRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
uuid string (uuid)
resource string (uri)
role string (uri)
user string (uri)
resource_uuid string (uuid)
role_uuid string (uuid)
user_uuid string (uuid)
resource_name string
role_name string
user_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
user_full_name string

Creates a new association between a user and a resource with a specific role. The user must have permission to manage users for the resource (typically service provider staff or owners).

1
2
3
4
5
6
7
http \
  POST \
  https://api.example.com/api/marketplace-resource-users/ \
  Authorization:"Token YOUR_API_TOKEN" \
  resource="https://api.example.com/api/resource/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  role="https://api.example.com/api/role/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  user="https://api.example.com/api/user/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.resource_user_request import ResourceUserRequest # (1)
from waldur_api_client.api.marketplace_resource_users import marketplace_resource_users_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ResourceUserRequest(
    resource="https://api.example.com/api/resource/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    role="https://api.example.com/api/role/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    user="https://api.example.com/api/user/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = marketplace_resource_users_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ResourceUserRequest
  2. API Source: marketplace_resource_users_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
import { marketplaceResourceUsersCreate } from 'waldur-js-client';

try {
  const response = await marketplaceResourceUsersCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "resource": "https://api.example.com/api/resource/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "role": "https://api.example.com/api/role/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "user": "https://api.example.com/api/user/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required
resource string (uri) ✓
role string (uri) ✓
user string (uri) ✓

201 -

Field Type Description
uuid string (uuid)
resource string (uri)
role string (uri)
user string (uri)
resource_uuid string (uuid)
role_uuid string (uuid)
user_uuid string (uuid)
resource_name string
role_name string
user_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
user_full_name string

Removes the association between a user and a resource, effectively revoking their role on that resource. The user must have permission to manage users for the resource.

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/marketplace-resource-users/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_resource_users import marketplace_resource_users_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_resource_users_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_resource_users_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceResourceUsersDestroy } from 'waldur-js-client';

try {
  const response = await marketplaceResourceUsersDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Marketplace Robot Accounts

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/marketplace-robot-accounts/ List robot accounts
GET /api/marketplace-robot-accounts/{uuid}/ Retrieve a robot account
POST /api/marketplace-robot-accounts/ Create a robot account
PUT /api/marketplace-robot-accounts/{uuid}/ Update a robot account
PATCH /api/marketplace-robot-accounts/{uuid}/ Partially update a robot account
DELETE /api/marketplace-robot-accounts/{uuid}/ Delete a robot account
Other Actions
POST /api/marketplace-robot-accounts/{uuid}/set_state_creating/ Set robot account state to creating
POST /api/marketplace-robot-accounts/{uuid}/set_state_deleted/ Set robot account state to deleted
POST /api/marketplace-robot-accounts/{uuid}/set_state_erred/ Set robot account state to erred
POST /api/marketplace-robot-accounts/{uuid}/set_state_ok/ Set robot account state to OK
POST /api/marketplace-robot-accounts/{uuid}/set_state_request_deletion/ Request deletion of a robot account

Core CRUD

List robot accounts

Returns a paginated list of robot accounts accessible to the current user.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-robot-accounts/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.remote_resource_sync_status_remote_state_enum import RemoteResourceSyncStatusRemoteStateEnum # (1)
from waldur_api_client.models.robot_account_details_field_enum import RobotAccountDetailsFieldEnum # (2)
from waldur_api_client.api.marketplace_robot_accounts import marketplace_robot_accounts_list # (3)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_robot_accounts_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: RemoteResourceSyncStatusRemoteStateEnum
  2. Model Source: RobotAccountDetailsFieldEnum
  3. API Source: marketplace_robot_accounts_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceRobotAccountsList } from 'waldur-js-client';

try {
  const response = await marketplaceRobotAccountsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
created string (date-time) Created after
customer_uuid string (uuid) Customer UUID
field array
modified string (date-time) Modified after
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
project_uuid string (uuid) Project UUID
provider_uuid string (uuid) Provider UUID
resource string (uri) Resource URL
resource_uuid string (uuid) Resource UUID
state integer Robot account state


Enum: 1, 2, 3, 4, 5, 6
type string

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
created string (date-time)
modified string (date-time)
username string
description string
error_message string
error_traceback string
state any
resource string (uri)
type string Type of the robot account.
users array of objects
users.url string (uri)
users.uuid string (uuid)
users.username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
users.full_name string
users.native_name string
users.email string (email)
users.image string (uri)
keys any
backend_id string
fingerprints array of objects
fingerprints.md5 string MD5 fingerprint of SSH key
fingerprints.sha256 string SHA256 fingerprint of SSH key
fingerprints.sha512 string SHA512 fingerprint of SSH key
responsible_user any
user_keys array of objects
user_keys.url string (uri)
user_keys.uuid string (uuid)
user_keys.name string
user_keys.public_key string
user_keys.fingerprint_md5 string
user_keys.fingerprint_sha256 string
user_keys.fingerprint_sha512 string
user_keys.user_uuid string (uuid)
user_keys.is_shared boolean
user_keys.type string
resource_name string
resource_uuid string (uuid)
project_name string
project_uuid string (uuid)
customer_uuid string (uuid)
customer_name string
provider_uuid string (uuid)
provider_name string
offering_plugin_options any

Retrieve a robot account

Returns the details of a specific robot account.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-robot-accounts/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.robot_account_details_field_enum import RobotAccountDetailsFieldEnum # (1)
from waldur_api_client.api.marketplace_robot_accounts import marketplace_robot_accounts_retrieve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_robot_accounts_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. Model Source: RobotAccountDetailsFieldEnum
  2. API Source: marketplace_robot_accounts_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceRobotAccountsRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceRobotAccountsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type
field array

200 -

Field Type Description
url string (uri)
uuid string (uuid)
created string (date-time)
modified string (date-time)
username string
description string
error_message string
error_traceback string
state any
resource string (uri)
type string Type of the robot account.
users array of objects
users.url string (uri)
users.uuid string (uuid)
users.username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
users.full_name string
users.native_name string
users.email string (email)
users.image string (uri)
keys any
backend_id string
fingerprints array of objects
fingerprints.md5 string MD5 fingerprint of SSH key
fingerprints.sha256 string SHA256 fingerprint of SSH key
fingerprints.sha512 string SHA512 fingerprint of SSH key
responsible_user any
user_keys array of objects
user_keys.url string (uri)
user_keys.uuid string (uuid)
user_keys.name string
user_keys.public_key string
user_keys.fingerprint_md5 string
user_keys.fingerprint_sha256 string
user_keys.fingerprint_sha512 string
user_keys.user_uuid string (uuid)
user_keys.is_shared boolean
user_keys.type string
resource_name string
resource_uuid string (uuid)
project_name string
project_uuid string (uuid)
customer_uuid string (uuid)
customer_name string
provider_uuid string (uuid)
provider_name string
offering_plugin_options any

Create a robot account

Creates a new robot account for a specific resource. This is typically used for automated access to a resource, e.g., for CI/CD pipelines.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/marketplace-robot-accounts/ \
  Authorization:"Token YOUR_API_TOKEN" \
  resource="https://api.example.com/api/resource/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  type="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.robot_account_request import RobotAccountRequest # (1)
from waldur_api_client.api.marketplace_robot_accounts import marketplace_robot_accounts_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = RobotAccountRequest(
    resource="https://api.example.com/api/resource/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    type="string-value"
)
response = marketplace_robot_accounts_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: RobotAccountRequest
  2. API Source: marketplace_robot_accounts_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { marketplaceRobotAccountsCreate } from 'waldur-js-client';

try {
  const response = await marketplaceRobotAccountsCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "resource": "https://api.example.com/api/resource/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "type": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
username string
description string
resource string (uri) ✓
type string ✓ Type of the robot account.
users array of string (uri)s Users who have access to this robot account.
keys any
responsible_user string (uri)

201 -

Field Type Description
url string (uri)
uuid string (uuid)
created string (date-time)
modified string (date-time)
username string
description string
error_message string
error_traceback string
state any
resource string (uri)
type string Type of the robot account.
users array of string (uri)s Users who have access to this robot account.
keys any
backend_id string
fingerprints array of objects
fingerprints.md5 string MD5 fingerprint of SSH key
fingerprints.sha256 string SHA256 fingerprint of SSH key
fingerprints.sha512 string SHA512 fingerprint of SSH key
responsible_user string (uri)

Update a robot account

Updates the properties of a robot account, such as its username or associated users. Not allowed for synchronized remote accounts.

1
2
3
4
5
6
http \
  PUT \
  https://api.example.com/api/marketplace-robot-accounts/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  resource="https://api.example.com/api/resource/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  type="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.robot_account_request import RobotAccountRequest # (1)
from waldur_api_client.api.marketplace_robot_accounts import marketplace_robot_accounts_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = RobotAccountRequest(
    resource="https://api.example.com/api/resource/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    type="string-value"
)
response = marketplace_robot_accounts_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: RobotAccountRequest
  2. API Source: marketplace_robot_accounts_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { marketplaceRobotAccountsUpdate } from 'waldur-js-client';

try {
  const response = await marketplaceRobotAccountsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "resource": "https://api.example.com/api/resource/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "type": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
username string
description string
resource string (uri) ✓
type string ✓ Type of the robot account.
users array of string (uri)s Users who have access to this robot account.
keys any
responsible_user string (uri)

200 -

Field Type Description
url string (uri)
uuid string (uuid)
created string (date-time)
modified string (date-time)
username string
description string
error_message string
error_traceback string
state any
resource string (uri)
type string Type of the robot account.
users array of string (uri)s Users who have access to this robot account.
keys any
backend_id string
fingerprints array of objects
fingerprints.md5 string MD5 fingerprint of SSH key
fingerprints.sha256 string SHA256 fingerprint of SSH key
fingerprints.sha512 string SHA512 fingerprint of SSH key
responsible_user string (uri)

Partially update a robot account

Partially updates the properties of a robot account. Not allowed for synchronized remote accounts.

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/marketplace-robot-accounts/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_robot_account_request import PatchedRobotAccountRequest # (1)
from waldur_api_client.api.marketplace_robot_accounts import marketplace_robot_accounts_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedRobotAccountRequest()
response = marketplace_robot_accounts_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedRobotAccountRequest
  2. API Source: marketplace_robot_accounts_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceRobotAccountsPartialUpdate } from 'waldur-js-client';

try {
  const response = await marketplaceRobotAccountsPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
username string
description string
resource string (uri)
type string Type of the robot account.
users array of string (uri)s Users who have access to this robot account.
keys any
responsible_user string (uri)

200 -

Field Type Description
url string (uri)
uuid string (uuid)
created string (date-time)
modified string (date-time)
username string
description string
error_message string
error_traceback string
state any
resource string (uri)
type string Type of the robot account.
users array of string (uri)s Users who have access to this robot account.
keys any
backend_id string
fingerprints array of objects
fingerprints.md5 string MD5 fingerprint of SSH key
fingerprints.sha256 string SHA256 fingerprint of SSH key
fingerprints.sha512 string SHA512 fingerprint of SSH key
responsible_user string (uri)

Delete a robot account

Deletes a robot account. This is a hard delete and should be used with caution.

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/marketplace-robot-accounts/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_robot_accounts import marketplace_robot_accounts_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_robot_accounts_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_robot_accounts_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceRobotAccountsDestroy } from 'waldur-js-client';

try {
  const response = await marketplaceRobotAccountsDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Other Actions

Set robot account state to creating

Transitions the robot account state from 'Requested' to 'Creating'. This is typically used by an agent to signal that the creation process has started.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-robot-accounts/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_state_creating/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_robot_accounts import marketplace_robot_accounts_set_state_creating # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_robot_accounts_set_state_creating.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_robot_accounts_set_state_creating
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceRobotAccountsSetStateCreating } from 'waldur-js-client';

try {
  const response = await marketplaceRobotAccountsSetStateCreating({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
url string (uri)
uuid string (uuid)
created string (date-time)
modified string (date-time)
username string
description string
error_message string
error_traceback string
state any
resource string (uri)
type string Type of the robot account.
users array of objects
users.url string (uri)
users.uuid string (uuid)
users.username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
users.full_name string
users.native_name string
users.email string (email)
users.image string (uri)
keys any
backend_id string
fingerprints array of objects
fingerprints.md5 string MD5 fingerprint of SSH key
fingerprints.sha256 string SHA256 fingerprint of SSH key
fingerprints.sha512 string SHA512 fingerprint of SSH key
responsible_user any
user_keys array of objects
user_keys.url string (uri)
user_keys.uuid string (uuid)
user_keys.name string
user_keys.public_key string
user_keys.fingerprint_md5 string
user_keys.fingerprint_sha256 string
user_keys.fingerprint_sha512 string
user_keys.user_uuid string (uuid)
user_keys.is_shared boolean
user_keys.type string
resource_name string
resource_uuid string (uuid)
project_name string
project_uuid string (uuid)
customer_uuid string (uuid)
customer_name string
provider_uuid string (uuid)
provider_name string
offering_plugin_options any

400 -

Field Type Description
detail string Error message to be displayed to the user

Set robot account state to deleted

Transitions the robot account state from 'Requested deletion' to 'Deleted', marking the successful completion of the deletion process.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-robot-accounts/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_state_deleted/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_robot_accounts import marketplace_robot_accounts_set_state_deleted # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_robot_accounts_set_state_deleted.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_robot_accounts_set_state_deleted
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceRobotAccountsSetStateDeleted } from 'waldur-js-client';

try {
  const response = await marketplaceRobotAccountsSetStateDeleted({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
url string (uri)
uuid string (uuid)
created string (date-time)
modified string (date-time)
username string
description string
error_message string
error_traceback string
state any
resource string (uri)
type string Type of the robot account.
users array of objects
users.url string (uri)
users.uuid string (uuid)
users.username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
users.full_name string
users.native_name string
users.email string (email)
users.image string (uri)
keys any
backend_id string
fingerprints array of objects
fingerprints.md5 string MD5 fingerprint of SSH key
fingerprints.sha256 string SHA256 fingerprint of SSH key
fingerprints.sha512 string SHA512 fingerprint of SSH key
responsible_user any
user_keys array of objects
user_keys.url string (uri)
user_keys.uuid string (uuid)
user_keys.name string
user_keys.public_key string
user_keys.fingerprint_md5 string
user_keys.fingerprint_sha256 string
user_keys.fingerprint_sha512 string
user_keys.user_uuid string (uuid)
user_keys.is_shared boolean
user_keys.type string
resource_name string
resource_uuid string (uuid)
project_name string
project_uuid string (uuid)
customer_uuid string (uuid)
customer_name string
provider_uuid string (uuid)
provider_name string
offering_plugin_options any

400 -

Field Type Description
detail string Error message to be displayed to the user

Set robot account state to erred

Manually moves the robot account into the 'Error' state. An optional error message can be provided.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-robot-accounts/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_state_erred/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.robot_account_error_request import RobotAccountErrorRequest # (1)
from waldur_api_client.api.marketplace_robot_accounts import marketplace_robot_accounts_set_state_erred # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = RobotAccountErrorRequest()
response = marketplace_robot_accounts_set_state_erred.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: RobotAccountErrorRequest
  2. API Source: marketplace_robot_accounts_set_state_erred
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceRobotAccountsSetStateErred } from 'waldur-js-client';

try {
  const response = await marketplaceRobotAccountsSetStateErred({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
error_message string Error message to be saved to the robot account

200 -

Field Type Description
url string (uri)
uuid string (uuid)
created string (date-time)
modified string (date-time)
username string
description string
error_message string
error_traceback string
state any
resource string (uri)
type string Type of the robot account.
users array of objects
users.url string (uri)
users.uuid string (uuid)
users.username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
users.full_name string
users.native_name string
users.email string (email)
users.image string (uri)
keys any
backend_id string
fingerprints array of objects
fingerprints.md5 string MD5 fingerprint of SSH key
fingerprints.sha256 string SHA256 fingerprint of SSH key
fingerprints.sha512 string SHA512 fingerprint of SSH key
responsible_user any
user_keys array of objects
user_keys.url string (uri)
user_keys.uuid string (uuid)
user_keys.name string
user_keys.public_key string
user_keys.fingerprint_md5 string
user_keys.fingerprint_sha256 string
user_keys.fingerprint_sha512 string
user_keys.user_uuid string (uuid)
user_keys.is_shared boolean
user_keys.type string
resource_name string
resource_uuid string (uuid)
project_name string
project_uuid string (uuid)
customer_uuid string (uuid)
customer_name string
provider_uuid string (uuid)
provider_name string
offering_plugin_options any

400 -

Field Type Description
detail string Error message to be displayed to the user

Set robot account state to OK

Manually sets the robot account state to 'OK', indicating that it is fully operational. This can be used to recover from an error state.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-robot-accounts/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_state_ok/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_robot_accounts import marketplace_robot_accounts_set_state_ok # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_robot_accounts_set_state_ok.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_robot_accounts_set_state_ok
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceRobotAccountsSetStateOk } from 'waldur-js-client';

try {
  const response = await marketplaceRobotAccountsSetStateOk({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
url string (uri)
uuid string (uuid)
created string (date-time)
modified string (date-time)
username string
description string
error_message string
error_traceback string
state any
resource string (uri)
type string Type of the robot account.
users array of objects
users.url string (uri)
users.uuid string (uuid)
users.username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
users.full_name string
users.native_name string
users.email string (email)
users.image string (uri)
keys any
backend_id string
fingerprints array of objects
fingerprints.md5 string MD5 fingerprint of SSH key
fingerprints.sha256 string SHA256 fingerprint of SSH key
fingerprints.sha512 string SHA512 fingerprint of SSH key
responsible_user any
user_keys array of objects
user_keys.url string (uri)
user_keys.uuid string (uuid)
user_keys.name string
user_keys.public_key string
user_keys.fingerprint_md5 string
user_keys.fingerprint_sha256 string
user_keys.fingerprint_sha512 string
user_keys.user_uuid string (uuid)
user_keys.is_shared boolean
user_keys.type string
resource_name string
resource_uuid string (uuid)
project_name string
project_uuid string (uuid)
customer_uuid string (uuid)
customer_name string
provider_uuid string (uuid)
provider_name string
offering_plugin_options any

400 -

Field Type Description
detail string Error message to be displayed to the user

Request deletion of a robot account

Transitions the robot account state from 'OK' to 'Requested deletion', initiating the deletion process.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-robot-accounts/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_state_request_deletion/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_robot_accounts import marketplace_robot_accounts_set_state_request_deletion # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_robot_accounts_set_state_request_deletion.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_robot_accounts_set_state_request_deletion
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceRobotAccountsSetStateRequestDeletion } from 'waldur-js-client';

try {
  const response = await marketplaceRobotAccountsSetStateRequestDeletion({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
url string (uri)
uuid string (uuid)
created string (date-time)
modified string (date-time)
username string
description string
error_message string
error_traceback string
state any
resource string (uri)
type string Type of the robot account.
users array of objects
users.url string (uri)
users.uuid string (uuid)
users.username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
users.full_name string
users.native_name string
users.email string (email)
users.image string (uri)
keys any
backend_id string
fingerprints array of objects
fingerprints.md5 string MD5 fingerprint of SSH key
fingerprints.sha256 string SHA256 fingerprint of SSH key
fingerprints.sha512 string SHA512 fingerprint of SSH key
responsible_user any
user_keys array of objects
user_keys.url string (uri)
user_keys.uuid string (uuid)
user_keys.name string
user_keys.public_key string
user_keys.fingerprint_md5 string
user_keys.fingerprint_sha256 string
user_keys.fingerprint_sha512 string
user_keys.user_uuid string (uuid)
user_keys.is_shared boolean
user_keys.type string
resource_name string
resource_uuid string (uuid)
project_name string
project_uuid string (uuid)
customer_uuid string (uuid)
customer_name string
provider_uuid string (uuid)
provider_name string
offering_plugin_options any

400 -

Field Type Description
detail string Error message to be displayed to the user

Marketplace User Offering Consents

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/marketplace-user-offering-consents/ List user offering consents
GET /api/marketplace-user-offering-consents/{uuid}/ Retrieve a user offering consent
POST /api/marketplace-user-offering-consents/ Grant consent to an offering's Terms of Service
PUT /api/marketplace-user-offering-consents/{uuid}/ Update
PATCH /api/marketplace-user-offering-consents/{uuid}/ Partial Update
DELETE /api/marketplace-user-offering-consents/{uuid}/ Delete
Other Actions
POST /api/marketplace-user-offering-consents/{uuid}/revoke/ Revoke consent to Terms of Service

Core CRUD

List user offering consents

Returns a paginated list of Terms of Service consents for the current user. Staff and support users can see all consents.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-user-offering-consents/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.user_offering_consent_o_enum import UserOfferingConsentOEnum # (1)
from waldur_api_client.api.marketplace_user_offering_consents import marketplace_user_offering_consents_list # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_user_offering_consents_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: UserOfferingConsentOEnum
  2. API Source: marketplace_user_offering_consents_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceUserOfferingConsentsList } from 'waldur-js-client';

try {
  const response = await marketplaceUserOfferingConsentsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
has_consent boolean Has consent
o array Ordering
offering string (uri) Offering URL
offering_uuid string (uuid) Offering UUID
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
requires_reconsent boolean Requires reconsent
user string (uri) User URL
user_uuid string (uuid) User UUID
version string Version

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid)
user_uuid string (uuid)
offering_uuid string (uuid)
agreement_date string (date-time)
version string
revocation_date string (date-time)
created string (date-time)
user_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
user_full_name string
user_email string (email)
offering_name string
offering_slug string
offering_url string (uri)
modified string (date-time)
has_consent boolean
requires_reconsent boolean
collected_attributes array of strings List of user attributes that will be shared with service provider

Returns the details of a specific consent record.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-user-offering-consents/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_user_offering_consents import marketplace_user_offering_consents_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_user_offering_consents_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_user_offering_consents_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceUserOfferingConsentsRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceUserOfferingConsentsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
uuid string (uuid)
user_uuid string (uuid)
offering_uuid string (uuid)
agreement_date string (date-time)
version string
revocation_date string (date-time)
created string (date-time)
user_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
user_full_name string
user_email string (email)
offering_name string
offering_slug string
offering_url string (uri)
modified string (date-time)
has_consent boolean
requires_reconsent boolean
collected_attributes array of strings List of user attributes that will be shared with service provider

Creates a consent record for the current user and a specific offering. This indicates that the user has accepted the active Terms of Service for that offering. If a consent already exists (even if revoked), it will be reactivated and updated with the current ToS version.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/marketplace-user-offering-consents/ \
  Authorization:"Token YOUR_API_TOKEN" \
  offering="a1b2c3d4-e5f6-7890-abcd-ef1234567890"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.user_offering_consent_create_request import UserOfferingConsentCreateRequest # (1)
from waldur_api_client.api.marketplace_user_offering_consents import marketplace_user_offering_consents_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = UserOfferingConsentCreateRequest(
    offering="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
)
response = marketplace_user_offering_consents_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: UserOfferingConsentCreateRequest
  2. API Source: marketplace_user_offering_consents_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceUserOfferingConsentsCreate } from 'waldur-js-client';

try {
  const response = await marketplaceUserOfferingConsentsCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "offering": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required
offering string (uuid) ✓

201 -

Field Type
offering string (uuid)

Update

1
2
3
4
http \
  PUT \
  https://api.example.com/api/marketplace-user-offering-consents/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.user_offering_consent_request import UserOfferingConsentRequest # (1)
from waldur_api_client.api.marketplace_user_offering_consents import marketplace_user_offering_consents_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = UserOfferingConsentRequest()
response = marketplace_user_offering_consents_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: UserOfferingConsentRequest
  2. API Source: marketplace_user_offering_consents_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceUserOfferingConsentsUpdate } from 'waldur-js-client';

try {
  const response = await marketplaceUserOfferingConsentsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
version string

200 -

Field Type Description
uuid string (uuid)
user_uuid string (uuid)
offering_uuid string (uuid)
agreement_date string (date-time)
version string
revocation_date string (date-time)
created string (date-time)
user_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
user_full_name string
user_email string (email)
offering_name string
offering_slug string
offering_url string (uri)
modified string (date-time)
has_consent boolean
requires_reconsent boolean
collected_attributes array of strings List of user attributes that will be shared with service provider

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/marketplace-user-offering-consents/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_user_offering_consent_request import PatchedUserOfferingConsentRequest # (1)
from waldur_api_client.api.marketplace_user_offering_consents import marketplace_user_offering_consents_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedUserOfferingConsentRequest()
response = marketplace_user_offering_consents_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedUserOfferingConsentRequest
  2. API Source: marketplace_user_offering_consents_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceUserOfferingConsentsPartialUpdate } from 'waldur-js-client';

try {
  const response = await marketplaceUserOfferingConsentsPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
version string

200 -

Field Type Description
uuid string (uuid)
user_uuid string (uuid)
offering_uuid string (uuid)
agreement_date string (date-time)
version string
revocation_date string (date-time)
created string (date-time)
user_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
user_full_name string
user_email string (email)
offering_name string
offering_slug string
offering_url string (uri)
modified string (date-time)
has_consent boolean
requires_reconsent boolean
collected_attributes array of strings List of user attributes that will be shared with service provider

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/marketplace-user-offering-consents/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_user_offering_consents import marketplace_user_offering_consents_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_user_offering_consents_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_user_offering_consents_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceUserOfferingConsentsDestroy } from 'waldur-js-client';

try {
  const response = await marketplaceUserOfferingConsentsDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Other Actions

Revokes a user's consent to the Terms of Service for an offering. The consent record is marked with a revocation date, and the user may lose access to related resources if consent is required.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-user-offering-consents/a1b2c3d4-e5f6-7890-abcd-ef1234567890/revoke/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_user_offering_consents import marketplace_user_offering_consents_revoke # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_user_offering_consents_revoke.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_user_offering_consents_revoke
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceUserOfferingConsentsRevoke } from 'waldur-js-client';

try {
  const response = await marketplaceUserOfferingConsentsRevoke({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
uuid string (uuid)
user_uuid string (uuid)
offering_uuid string (uuid)
agreement_date string (date-time)
version string
revocation_date string (date-time)
created string (date-time)
user_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
user_full_name string
user_email string (email)
offering_name string
offering_slug string
offering_url string (uri)
modified string (date-time)
has_consent boolean
requires_reconsent boolean
collected_attributes array of strings List of user attributes that will be shared with service provider

Arrow

Admin Arrow Billing Sync Items

Operations Summary

Method Endpoint Description
GET /api/admin/arrow/billing-sync-items/ Billing sync items
GET /api/admin/arrow/billing-sync-items/{uuid}/ Retrieve

Billing sync items

1
2
3
4
http \
  GET \
  https://api.example.com/api/admin/arrow/billing-sync-items/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.admin import admin_arrow_billing_sync_items_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = admin_arrow_billing_sync_items_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: admin_arrow_billing_sync_items_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { adminArrowBillingSyncItemsList } from 'waldur-js-client';

try {
  const response = await adminArrowBillingSyncItemsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
arrow_line_reference string
billing_sync string (uri)
billing_sync_uuid string (uuid)
classification string
has_compensation boolean
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
report_period string
subscription_reference string
vendor_name string

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid)
url string (uri)
billing_sync string (uri)
billing_sync_uuid string (uuid)
report_period string Report period in YYYY-MM format
arrow_line_reference string Arrow line ID
invoice_item_uuid string (uuid)
original_price string (decimal) Original price for reconciliation tracking
compensation_item_uuid string (uuid)
has_compensation boolean
vendor_name string Vendor name (e.g., Microsoft)
subscription_reference string Arrow subscription reference
classification string Classification (IAAS/SAAS)
description string Line item description
quantity string (decimal) Quantity
created string (date-time)

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/admin/arrow/billing-sync-items/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.admin import admin_arrow_billing_sync_items_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = admin_arrow_billing_sync_items_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: admin_arrow_billing_sync_items_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { adminArrowBillingSyncItemsRetrieve } from 'waldur-js-client';

try {
  const response = await adminArrowBillingSyncItemsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
uuid string (uuid)
url string (uri)
billing_sync string (uri)
billing_sync_uuid string (uuid)
report_period string Report period in YYYY-MM format
arrow_line_reference string Arrow line ID
invoice_item_uuid string (uuid)
original_price string (decimal) Original price for reconciliation tracking
compensation_item_uuid string (uuid)
has_compensation boolean
vendor_name string Vendor name (e.g., Microsoft)
subscription_reference string Arrow subscription reference
classification string Classification (IAAS/SAAS)
description string Line item description
quantity string (decimal) Quantity
created string (date-time)

Admin Arrow Billing Syncs

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/admin/arrow/billing-syncs/ Billing syncs
GET /api/admin/arrow/billing-syncs/{uuid}/ Retrieve
Sync Control
POST /api/admin/arrow/billing-syncs/pause_sync/ Pause consumption sync operations
POST /api/admin/arrow/billing-syncs/reconcile/ Trigger reconciliation for a specific period
POST /api/admin/arrow/billing-syncs/resume_sync/ Resume consumption sync operations
POST /api/admin/arrow/billing-syncs/trigger_consumption_sync/ Trigger consumption sync for a specific period
POST /api/admin/arrow/billing-syncs/trigger_reconciliation/ Trigger reconciliation (check billing export and apply adjustments)
POST /api/admin/arrow/billing-syncs/trigger_sync/ Trigger billing sync for a specific period
Data Retrieval
GET /api/admin/arrow/billing-syncs/consumption_statistics/ Get consumption statistics
GET /api/admin/arrow/billing-syncs/consumption_status/ Get current consumption sync status
GET /api/admin/arrow/billing-syncs/pending_records/ List pending consumption records (not yet finalized)
POST /api/admin/arrow/billing-syncs/fetch_billing_export/ Fetch raw billing export from Arrow API
POST /api/admin/arrow/billing-syncs/fetch_consumption/ Fetch raw consumption data from Arrow API
POST /api/admin/arrow/billing-syncs/fetch_license_info/ Fetch license details from Arrow API
POST /api/admin/arrow/billing-syncs/sync_resource_historical_consumption/ Sync historical consumption for a specific resource from Arrow
POST /api/admin/arrow/billing-syncs/sync_resources/ Sync resources
Cleanup
POST /api/admin/arrow/billing-syncs/cleanup_consumption/ Delete consumption records with optional dry-run preview

Core CRUD

Billing syncs

1
2
3
4
http \
  GET \
  https://api.example.com/api/admin/arrow/billing-syncs/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.admin import admin_arrow_billing_syncs_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = admin_arrow_billing_syncs_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: admin_arrow_billing_syncs_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { adminArrowBillingSyncsList } from 'waldur-js-client';

try {
  const response = await adminArrowBillingSyncsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
arrow_state string
customer_mapping string (uri)
customer_mapping_uuid string (uuid)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
report_period string
report_period_from string
report_period_to string
settings_uuid string (uuid)
state integer
statement_reference string

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid)
url string (uri)
customer_mapping string (uri)
customer_mapping_uuid string (uuid)
arrow_reference string Arrow customer ID (e.g., 'XSP661245')
waldur_customer_name string
statement_reference string Arrow statement ID
report_period string Report period in YYYY-MM format
arrow_state string Arrow billing state (pending/validated)
state any Waldur sync state
state_display string
buy_total string (decimal) Total buy amount
sell_total string (decimal) Total sell amount
currency string Currency code
invoice_uuid string (uuid)
error_message string Error message if sync failed
synced_at string (date-time) When billing was last synced
validated_at string (date-time) When Arrow validated the billing
reconciled_at string (date-time) When reconciliation was applied
items array of objects
items.uuid string (uuid)
items.arrow_line_reference string Arrow line ID
items.invoice_item_uuid string (uuid)
items.original_price string (decimal) Original price for reconciliation tracking
items.compensation_item_uuid string (uuid)
items.vendor_name string Vendor name (e.g., Microsoft)
items.subscription_reference string Arrow subscription reference
items.classification string Classification (IAAS/SAAS)
items.description string Line item description
items.quantity string (decimal) Quantity
items.created string (date-time)
created string (date-time)
modified string (date-time)

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/admin/arrow/billing-syncs/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.admin import admin_arrow_billing_syncs_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = admin_arrow_billing_syncs_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: admin_arrow_billing_syncs_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { adminArrowBillingSyncsRetrieve } from 'waldur-js-client';

try {
  const response = await adminArrowBillingSyncsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
uuid string (uuid)
url string (uri)
customer_mapping string (uri)
customer_mapping_uuid string (uuid)
arrow_reference string Arrow customer ID (e.g., 'XSP661245')
waldur_customer_name string
statement_reference string Arrow statement ID
report_period string Report period in YYYY-MM format
arrow_state string Arrow billing state (pending/validated)
state any Waldur sync state
state_display string
buy_total string (decimal) Total buy amount
sell_total string (decimal) Total sell amount
currency string Currency code
invoice_uuid string (uuid)
error_message string Error message if sync failed
synced_at string (date-time) When billing was last synced
validated_at string (date-time) When Arrow validated the billing
reconciled_at string (date-time) When reconciliation was applied
items array of objects
items.uuid string (uuid)
items.arrow_line_reference string Arrow line ID
items.invoice_item_uuid string (uuid)
items.original_price string (decimal) Original price for reconciliation tracking
items.compensation_item_uuid string (uuid)
items.vendor_name string Vendor name (e.g., Microsoft)
items.subscription_reference string Arrow subscription reference
items.classification string Classification (IAAS/SAAS)
items.description string Line item description
items.quantity string (decimal) Quantity
items.created string (date-time)
created string (date-time)
modified string (date-time)

Sync Control

Pause consumption sync operations

Pause consumption sync operations.

1
2
3
4
http \
  POST \
  https://api.example.com/api/admin/arrow/billing-syncs/pause_sync/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.sync_pause_request_request import SyncPauseRequestRequest # (1)
from waldur_api_client.api.admin import admin_arrow_billing_syncs_pause_sync # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = SyncPauseRequestRequest()
response = admin_arrow_billing_syncs_pause_sync.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: SyncPauseRequestRequest
  2. API Source: admin_arrow_billing_syncs_pause_sync
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { adminArrowBillingSyncsPauseSync } from 'waldur-js-client';

try {
  const response = await adminArrowBillingSyncsPauseSync({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required
settings_uuid string (uuid)
pause_global boolean

200 -

Field Type Description
paused array of strings List of paused items
resumed array of strings List of resumed items

Trigger reconciliation for a specific period

Trigger reconciliation for a specific period.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/admin/arrow/billing-syncs/reconcile/ \
  Authorization:"Token YOUR_API_TOKEN" \
  year=123 \
  month=123

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.reconcile_request_request import ReconcileRequestRequest # (1)
from waldur_api_client.api.admin import admin_arrow_billing_syncs_reconcile # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ReconcileRequestRequest(
    year=123,
    month=123
)
response = admin_arrow_billing_syncs_reconcile.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ReconcileRequestRequest
  2. API Source: admin_arrow_billing_syncs_reconcile
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { adminArrowBillingSyncsReconcile } from 'waldur-js-client';

try {
  const response = await adminArrowBillingSyncsReconcile({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "year": 123,
    "month": 123
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
year integer ✓
month integer ✓
settings_uuid string (uuid)
force boolean Force reconciliation even if not validated
Constraints: default: False

202 - No response body

Resume consumption sync operations

Resume consumption sync operations.

1
2
3
4
http \
  POST \
  https://api.example.com/api/admin/arrow/billing-syncs/resume_sync/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.sync_pause_request_request import SyncPauseRequestRequest # (1)
from waldur_api_client.api.admin import admin_arrow_billing_syncs_resume_sync # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = SyncPauseRequestRequest()
response = admin_arrow_billing_syncs_resume_sync.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: SyncPauseRequestRequest
  2. API Source: admin_arrow_billing_syncs_resume_sync
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { adminArrowBillingSyncsResumeSync } from 'waldur-js-client';

try {
  const response = await adminArrowBillingSyncsResumeSync({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required
settings_uuid string (uuid)
pause_global boolean

200 -

Field Type Description
paused array of strings List of paused items
resumed array of strings List of resumed items

Trigger consumption sync for a specific period

Trigger consumption sync for a specific period.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/admin/arrow/billing-syncs/trigger_consumption_sync/ \
  Authorization:"Token YOUR_API_TOKEN" \
  year=123 \
  month=123

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.trigger_consumption_sync_request_request import TriggerConsumptionSyncRequestRequest # (1)
from waldur_api_client.api.admin import admin_arrow_billing_syncs_trigger_consumption_sync # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = TriggerConsumptionSyncRequestRequest(
    year=123,
    month=123
)
response = admin_arrow_billing_syncs_trigger_consumption_sync.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: TriggerConsumptionSyncRequestRequest
  2. API Source: admin_arrow_billing_syncs_trigger_consumption_sync
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { adminArrowBillingSyncsTriggerConsumptionSync } from 'waldur-js-client';

try {
  const response = await adminArrowBillingSyncsTriggerConsumptionSync({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "year": 123,
    "month": 123
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
year integer ✓
month integer ✓
settings_uuid string (uuid)
resource_uuid string (uuid) Sync specific resource only

202 - No response body

Trigger reconciliation (check billing export and apply adjustments)

Trigger reconciliation (check billing export and apply adjustments).

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/admin/arrow/billing-syncs/trigger_reconciliation/ \
  Authorization:"Token YOUR_API_TOKEN" \
  year=123 \
  month=123

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.reconcile_request_request import ReconcileRequestRequest # (1)
from waldur_api_client.api.admin import admin_arrow_billing_syncs_trigger_reconciliation # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ReconcileRequestRequest(
    year=123,
    month=123
)
response = admin_arrow_billing_syncs_trigger_reconciliation.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ReconcileRequestRequest
  2. API Source: admin_arrow_billing_syncs_trigger_reconciliation
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { adminArrowBillingSyncsTriggerReconciliation } from 'waldur-js-client';

try {
  const response = await adminArrowBillingSyncsTriggerReconciliation({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "year": 123,
    "month": 123
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
year integer ✓
month integer ✓
settings_uuid string (uuid)
force boolean Force reconciliation even if not validated
Constraints: default: False

202 - No response body

Trigger billing sync for a specific period

Trigger billing sync for a specific period.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/admin/arrow/billing-syncs/trigger_sync/ \
  Authorization:"Token YOUR_API_TOKEN" \
  year=123 \
  month=123

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.trigger_sync_request_request import TriggerSyncRequestRequest # (1)
from waldur_api_client.api.admin import admin_arrow_billing_syncs_trigger_sync # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = TriggerSyncRequestRequest(
    year=123,
    month=123
)
response = admin_arrow_billing_syncs_trigger_sync.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: TriggerSyncRequestRequest
  2. API Source: admin_arrow_billing_syncs_trigger_sync
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { adminArrowBillingSyncsTriggerSync } from 'waldur-js-client';

try {
  const response = await adminArrowBillingSyncsTriggerSync({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "year": 123,
    "month": 123
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
year integer ✓
month integer ✓
settings_uuid string (uuid)
resource_uuid string (uuid) If set, only sync billing lines for this resource.

202 - No response body

Data Retrieval

Get consumption statistics

Get consumption statistics.

1
2
3
4
http \
  GET \
  https://api.example.com/api/admin/arrow/billing-syncs/consumption_statistics/ \
  Authorization:"Token YOUR_API_TOKEN"

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.admin import admin_arrow_billing_syncs_consumption_statistics_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = admin_arrow_billing_syncs_consumption_statistics_retrieve.sync(client=client)

print(response)
  1. API Source: admin_arrow_billing_syncs_consumption_statistics_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { adminArrowBillingSyncsConsumptionStatisticsRetrieve } from 'waldur-js-client';

try {
  const response = await adminArrowBillingSyncsConsumptionStatisticsRetrieve({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

200 -

Field Type
total_records integer
pending_records integer
finalized_records integer
reconciled_records integer
total_consumed_sell string (decimal)
total_adjustments string (decimal)
period_breakdown array of objects
period_breakdown.period string
period_breakdown.count integer
period_breakdown.consumed_sell string (decimal)
period_breakdown.finalized_count integer
period_breakdown.reconciled_count integer

Get current consumption sync status

Get current consumption sync status.

1
2
3
4
http \
  GET \
  https://api.example.com/api/admin/arrow/billing-syncs/consumption_status/ \
  Authorization:"Token YOUR_API_TOKEN"

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.admin import admin_arrow_billing_syncs_consumption_status_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = admin_arrow_billing_syncs_consumption_status_retrieve.sync(client=client)

print(response)
  1. API Source: admin_arrow_billing_syncs_consumption_status_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { adminArrowBillingSyncsConsumptionStatusRetrieve } from 'waldur-js-client';

try {
  const response = await adminArrowBillingSyncsConsumptionStatusRetrieve({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

200 -

Field Type
global_sync_enabled boolean
settings_sync_enabled boolean
settings_uuid string (uuid)
last_sync_run string (date-time)

List pending consumption records (not yet finalized)

List pending consumption records (not yet finalized).

1
2
3
4
http \
  GET \
  https://api.example.com/api/admin/arrow/billing-syncs/pending_records/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.admin import admin_arrow_billing_syncs_pending_records_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = admin_arrow_billing_syncs_pending_records_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: admin_arrow_billing_syncs_pending_records_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { adminArrowBillingSyncsPendingRecordsList } from 'waldur-js-client';

try {
  const response = await adminArrowBillingSyncsPendingRecordsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
arrow_state string
customer_mapping string (uri)
customer_mapping_uuid string (uuid)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
report_period string
report_period_from string
report_period_to string
settings_uuid string (uuid)
state integer
statement_reference string

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
uuid string (uuid)
resource_uuid string (uuid)
resource_name string
license_reference string
billing_period string (date)
consumed_sell string (decimal)
last_sync_at string (date-time)

Fetch raw billing export from Arrow API

Fetch raw billing export from Arrow API.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/admin/arrow/billing-syncs/fetch_billing_export/ \
  Authorization:"Token YOUR_API_TOKEN" \
  period_from="string-value" \
  period_to="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.fetch_billing_export_request_request import FetchBillingExportRequestRequest # (1)
from waldur_api_client.api.admin import admin_arrow_billing_syncs_fetch_billing_export # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = FetchBillingExportRequestRequest(
    period_from="string-value",
    period_to="string-value"
)
response = admin_arrow_billing_syncs_fetch_billing_export.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: FetchBillingExportRequestRequest
  2. API Source: admin_arrow_billing_syncs_fetch_billing_export
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { adminArrowBillingSyncsFetchBillingExport } from 'waldur-js-client';

try {
  const response = await adminArrowBillingSyncsFetchBillingExport({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "period_from": "string-value",
    "period_to": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
period_from string ✓ YYYY-MM format
period_to string ✓ YYYY-MM format
classification string

200 -

Field Type
period_from string
period_to string
classification string
row_count integer
data array of objects

Fetch raw consumption data from Arrow API

Fetch raw consumption data from Arrow API.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/admin/arrow/billing-syncs/fetch_consumption/ \
  Authorization:"Token YOUR_API_TOKEN" \
  license_reference="string-value" \
  period="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.fetch_consumption_request_request import FetchConsumptionRequestRequest # (1)
from waldur_api_client.api.admin import admin_arrow_billing_syncs_fetch_consumption # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = FetchConsumptionRequestRequest(
    license_reference="string-value",
    period="string-value"
)
response = admin_arrow_billing_syncs_fetch_consumption.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: FetchConsumptionRequestRequest
  2. API Source: admin_arrow_billing_syncs_fetch_consumption
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { adminArrowBillingSyncsFetchConsumption } from 'waldur-js-client';

try {
  const response = await adminArrowBillingSyncsFetchConsumption({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "license_reference": "string-value",
    "period": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
license_reference string ✓
period string ✓ YYYY-MM format

200 -

Field Type
license_reference string
period string
row_count integer
data array of objects

Fetch license details from Arrow API

Fetch license details from Arrow API.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/admin/arrow/billing-syncs/fetch_license_info/ \
  Authorization:"Token YOUR_API_TOKEN" \
  license_reference="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.fetch_license_info_request_request import FetchLicenseInfoRequestRequest # (1)
from waldur_api_client.api.admin import admin_arrow_billing_syncs_fetch_license_info # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = FetchLicenseInfoRequestRequest(
    license_reference="string-value"
)
response = admin_arrow_billing_syncs_fetch_license_info.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: FetchLicenseInfoRequestRequest
  2. API Source: admin_arrow_billing_syncs_fetch_license_info
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { adminArrowBillingSyncsFetchLicenseInfo } from 'waldur-js-client';

try {
  const response = await adminArrowBillingSyncsFetchLicenseInfo({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "license_reference": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required
license_reference string ✓

200 -

Field Type Description
data object (free-form) Raw license data from Arrow API

Sync historical consumption for a specific resource from Arrow

Sync historical consumption for a specific resource from Arrow.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/admin/arrow/billing-syncs/sync_resource_historical_consumption/ \
  Authorization:"Token YOUR_API_TOKEN" \
  resource_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.sync_resource_historical_consumption_request_request import SyncResourceHistoricalConsumptionRequestRequest # (1)
from waldur_api_client.api.admin import admin_arrow_billing_syncs_sync_resource_historical_consumption # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = SyncResourceHistoricalConsumptionRequestRequest(
    resource_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
)
response = admin_arrow_billing_syncs_sync_resource_historical_consumption.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: SyncResourceHistoricalConsumptionRequestRequest
  2. API Source: admin_arrow_billing_syncs_sync_resource_historical_consumption
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { adminArrowBillingSyncsSyncResourceHistoricalConsumption } from 'waldur-js-client';

try {
  const response = await adminArrowBillingSyncsSyncResourceHistoricalConsumption({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "resource_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
resource_uuid string (uuid) ✓ UUID of the resource to sync
period_from string Start period in YYYY-MM format. Defaults to 12 months ago.
period_to string End period in YYYY-MM format. Defaults to current month.
force boolean If True, sync even for finalized periods.
Constraints: default: False
dry_run boolean If True, preview consumption data without saving.
Constraints: default: False

200 -

Field Type
resource_uuid string (uuid)
resource_name string
periods_synced integer
periods_skipped integer
periods_no_data integer
errors array of objects
dry_run boolean
preview_periods array of objects

Sync resources

Sync Arrow IAAS subscriptions to Waldur Resources. Matches subscriptions by Vendor Subscription ID to resource backend_id. Updates resource report and current_usages fields. With force_import=True, auto-creates Customers and Projects from Arrow data.

1
2
3
4
http \
  POST \
  https://api.example.com/api/admin/arrow/billing-syncs/sync_resources/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.sync_resources_request_request import SyncResourcesRequestRequest # (1)
from waldur_api_client.api.admin import admin_arrow_billing_syncs_sync_resources # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = SyncResourcesRequestRequest()
response = admin_arrow_billing_syncs_sync_resources.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: SyncResourcesRequestRequest
  2. API Source: admin_arrow_billing_syncs_sync_resources
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { adminArrowBillingSyncsSyncResources } from 'waldur-js-client';

try {
  const response = await adminArrowBillingSyncsSyncResources({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
period_from string Start period in YYYY-MM format (default: 6 months ago, Arrow max)
period_to string End period in YYYY-MM format (default: current month)
settings_uuid string (uuid)
offering_uuid string (uuid) Offering UUID for creating new resources
project_uuid string (uuid) Project UUID for creating new resources (ignored if force_import=True)
force_import boolean If True, auto-create Waldur Customers and Projects from Arrow data. Each Arrow customer gets a Waldur Customer with an 'Arrow Azure Subscriptions' project.
Constraints: default: False

200 -

Field Type
synced integer
created integer
updated integer
orders_created integer
customers_created integer
projects_created integer
mappings_created integer
invoices_created integer
invoice_items_created integer
errors array of objects

Cleanup

Delete consumption records with optional dry-run preview

Delete consumption records with optional dry-run preview.

1
2
3
4
http \
  POST \
  https://api.example.com/api/admin/arrow/billing-syncs/cleanup_consumption/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.cleanup_consumption_request_request import CleanupConsumptionRequestRequest # (1)
from waldur_api_client.api.admin import admin_arrow_billing_syncs_cleanup_consumption # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = CleanupConsumptionRequestRequest()
response = admin_arrow_billing_syncs_cleanup_consumption.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: CleanupConsumptionRequestRequest
  2. API Source: admin_arrow_billing_syncs_cleanup_consumption
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { adminArrowBillingSyncsCleanupConsumption } from 'waldur-js-client';

try {
  const response = await adminArrowBillingSyncsCleanupConsumption({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
period_from string YYYY-MM format
period_to string YYYY-MM format
resource_uuid string (uuid)
only_finalized boolean
Constraints: default: False
only_unfinalized boolean
Constraints: default: False
dry_run boolean
Constraints: default: True

200 -

Field Type
dry_run boolean
records_to_delete integer
records_deleted integer
compensation_items_affected integer
invoice_items_affected integer

Admin Arrow Consumption Records

Operations Summary

Method Endpoint Description
GET /api/admin/arrow/consumption-records/ Consumption records
GET /api/admin/arrow/consumption-records/{uuid}/ Retrieve

Consumption records

1
2
3
4
http \
  GET \
  https://api.example.com/api/admin/arrow/consumption-records/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.admin import admin_arrow_consumption_records_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = admin_arrow_consumption_records_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: admin_arrow_consumption_records_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { adminArrowConsumptionRecordsList } from 'waldur-js-client';

try {
  const response = await adminArrowConsumptionRecordsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
billing_period string (date)
billing_period_from string (date)
billing_period_to string (date)
customer_uuid string (uuid)
is_finalized boolean
is_reconciled boolean
license_reference string
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
project_uuid string (uuid)
resource string (uri)
resource_uuid string (uuid)

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid)
url string (uri)
resource string (uri)
resource_uuid string (uuid)
resource_name string
project_uuid string (uuid)
project_name string
customer_uuid string (uuid)
customer_name string
license_reference string Arrow license reference (e.g., 'XSP12345')
billing_period string (date) First day of the billing month
consumed_sell string (decimal) Consumed sell amount from Consumption API
consumed_buy string (decimal) Consumed buy amount from Consumption API
final_sell string (decimal) Final sell amount from billing export
final_buy string (decimal) Final buy amount from billing export
invoice_item_uuid string (uuid)
compensation_item_uuid string (uuid)
last_sync_at string (date-time) When consumption was last synced from API
finalized_at string (date-time) When billing export data arrived
reconciled_at string (date-time) When reconciliation was applied
is_finalized boolean
is_reconciled boolean
adjustment_amount string (decimal)
raw_data any Raw consumption data for debugging
created string (date-time)
modified string (date-time)

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/admin/arrow/consumption-records/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.admin import admin_arrow_consumption_records_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = admin_arrow_consumption_records_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: admin_arrow_consumption_records_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { adminArrowConsumptionRecordsRetrieve } from 'waldur-js-client';

try {
  const response = await adminArrowConsumptionRecordsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
uuid string (uuid)
url string (uri)
resource string (uri)
resource_uuid string (uuid)
resource_name string
project_uuid string (uuid)
project_name string
customer_uuid string (uuid)
customer_name string
license_reference string Arrow license reference (e.g., 'XSP12345')
billing_period string (date) First day of the billing month
consumed_sell string (decimal) Consumed sell amount from Consumption API
consumed_buy string (decimal) Consumed buy amount from Consumption API
final_sell string (decimal) Final sell amount from billing export
final_buy string (decimal) Final buy amount from billing export
invoice_item_uuid string (uuid)
compensation_item_uuid string (uuid)
last_sync_at string (date-time) When consumption was last synced from API
finalized_at string (date-time) When billing export data arrived
reconciled_at string (date-time) When reconciliation was applied
is_finalized boolean
is_reconciled boolean
adjustment_amount string (decimal)
raw_data any Raw consumption data for debugging
created string (date-time)
modified string (date-time)

Admin Arrow Customer Mappings

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/admin/arrow/customer-mappings/ Customer mappings
GET /api/admin/arrow/customer-mappings/{uuid}/ Retrieve
Data Retrieval
GET /api/admin/arrow/customer-mappings/available_customers/ Available customers
GET /api/admin/arrow/customer-mappings/{uuid}/billing_summary/ Get billing and consumption summary for this customer mapping
GET /api/admin/arrow/customer-mappings/{uuid}/discover_licenses/ Discover Arrow licenses for this customer and show linkable Waldur resources
GET /api/admin/arrow/customer-mappings/{uuid}/fetch_arrow_data/ Fetch fresh consumption and billing data from Arrow API for this customer
Sync & Management
POST /api/admin/arrow/customer-mappings/{uuid}/import_license/ Import an Arrow license as a new Waldur resource
POST /api/admin/arrow/customer-mappings/{uuid}/link_resource/ Link a Waldur resource to an Arrow license by setting its backend_id
POST /api/admin/arrow/customer-mappings/sync_from_arrow/ Sync customer list from Arrow and update arrow_company_name
Other Actions
POST /api/admin/arrow/customer-mappings/ Customer mappings
PUT /api/admin/arrow/customer-mappings/{uuid}/ Update
PATCH /api/admin/arrow/customer-mappings/{uuid}/ Partial Update
DELETE /api/admin/arrow/customer-mappings/{uuid}/ Delete

Core CRUD

Customer mappings

1
2
3
4
http \
  GET \
  https://api.example.com/api/admin/arrow/customer-mappings/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.admin import admin_arrow_customer_mappings_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = admin_arrow_customer_mappings_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: admin_arrow_customer_mappings_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { adminArrowCustomerMappingsList } from 'waldur-js-client';

try {
  const response = await adminArrowCustomerMappingsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
arrow_company_name string
arrow_reference string
is_active boolean
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
settings string (uri)
settings_uuid string (uuid)
waldur_customer string (uri)
waldur_customer_uuid string (uuid)

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid)
url string (uri)
settings string (uri)
settings_uuid string (uuid)
arrow_reference string Arrow customer ID (e.g., 'XSP661245')
arrow_company_name string Arrow company name
waldur_customer string (uri)
waldur_customer_uuid string (uuid)
waldur_customer_name string
is_active boolean Whether this mapping is active
created string (date-time)
modified string (date-time)

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/admin/arrow/customer-mappings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.admin import admin_arrow_customer_mappings_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = admin_arrow_customer_mappings_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: admin_arrow_customer_mappings_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { adminArrowCustomerMappingsRetrieve } from 'waldur-js-client';

try {
  const response = await adminArrowCustomerMappingsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
uuid string (uuid)
url string (uri)
settings string (uri)
settings_uuid string (uuid)
arrow_reference string Arrow customer ID (e.g., 'XSP661245')
arrow_company_name string Arrow company name
waldur_customer string (uri)
waldur_customer_uuid string (uuid)
waldur_customer_name string
is_active boolean Whether this mapping is active
created string (date-time)
modified string (date-time)

Data Retrieval

Available customers

Get available Arrow customers that are not yet mapped, with suggestions for Waldur organization matches.

1
2
3
4
http \
  GET \
  https://api.example.com/api/admin/arrow/customer-mappings/available_customers/ \
  Authorization:"Token YOUR_API_TOKEN"

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.admin import admin_arrow_customer_mappings_available_customers_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = admin_arrow_customer_mappings_available_customers_retrieve.sync(client=client)

print(response)
  1. API Source: admin_arrow_customer_mappings_available_customers_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { adminArrowCustomerMappingsAvailableCustomersRetrieve } from 'waldur-js-client';

try {
  const response = await adminArrowCustomerMappingsAvailableCustomersRetrieve({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

200 -

Field Type
settings_uuid string (uuid)
arrow_customers array of objects
arrow_customers.reference string
arrow_customers.companyName string
arrow_customers.email string
arrow_customers.city string
arrow_customers.countryCode string
waldur_customers array of objects
waldur_customers.uuid string (uuid)
waldur_customers.name string
waldur_customers.abbreviation string
suggestions array of objects
suggestions.arrow_customer object
suggestions.arrow_customer.reference string
suggestions.arrow_customer.companyName string
suggestions.arrow_customer.email string
suggestions.arrow_customer.city string
suggestions.arrow_customer.countryCode string
suggestions.suggested_waldur_customer object
suggestions.suggested_waldur_customer.uuid string (uuid)
suggestions.suggested_waldur_customer.name string
suggestions.suggested_waldur_customer.abbreviation string
suggestions.confidence number (double)
suggestions.existing_mapping boolean

Get billing and consumption summary for this customer mapping

Get billing and consumption summary for this customer mapping.

1
2
3
4
http \
  GET \
  https://api.example.com/api/admin/arrow/customer-mappings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/billing_summary/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.admin import admin_arrow_customer_mappings_billing_summary_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = admin_arrow_customer_mappings_billing_summary_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: admin_arrow_customer_mappings_billing_summary_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { adminArrowCustomerMappingsBillingSummaryRetrieve } from 'waldur-js-client';

try {
  const response = await adminArrowCustomerMappingsBillingSummaryRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
customer_mapping_uuid string (uuid)
arrow_reference string
arrow_company_name string
waldur_customer_uuid string (uuid)
waldur_customer_name string
total_consumption_records integer
total_consumed_sell string (decimal)
total_final_sell string (decimal)
pending_records integer
finalized_records integer
reconciled_records integer
total_billing_syncs integer
total_billing_sell string (decimal)
recent_consumption_records array of objects
recent_consumption_records.uuid string (uuid)
recent_consumption_records.license_reference string
recent_consumption_records.resource_name string
recent_consumption_records.billing_period string (date)
recent_consumption_records.consumed_sell string (decimal)
recent_consumption_records.final_sell string (decimal)
recent_consumption_records.is_finalized boolean
recent_consumption_records.is_reconciled boolean
recent_billing_syncs array of objects
recent_billing_syncs.uuid string (uuid)
recent_billing_syncs.report_period string
recent_billing_syncs.state string
recent_billing_syncs.sell_total string (decimal)
recent_billing_syncs.items_count integer
recent_billing_syncs.created string (date-time)

Discover Arrow licenses for this customer and show linkable Waldur resources

Discover Arrow licenses for this customer and show linkable Waldur resources.

1
2
3
4
http \
  GET \
  https://api.example.com/api/admin/arrow/customer-mappings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/discover_licenses/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.admin import admin_arrow_customer_mappings_discover_licenses_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = admin_arrow_customer_mappings_discover_licenses_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: admin_arrow_customer_mappings_discover_licenses_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { adminArrowCustomerMappingsDiscoverLicensesRetrieve } from 'waldur-js-client';

try {
  const response = await adminArrowCustomerMappingsDiscoverLicensesRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
customer_mapping_uuid string (uuid)
arrow_reference string
waldur_customer_name string
arrow_licenses array of objects Arrow licenses from billing export for this customer.
arrow_licenses.license_reference string Arrow license reference (e.g., XSP12345). Use this as resource backend_id.
arrow_licenses.vendor_name string
arrow_licenses.offer_name string
arrow_licenses.offer_sku string
arrow_licenses.friendly_name string
waldur_resources array of objects Waldur resources for this customer.
waldur_resources.uuid string (uuid)
waldur_resources.name string
waldur_resources.backend_id string Current backend_id (Arrow license reference if linked).
waldur_resources.project_name string
waldur_resources.offering_name string
waldur_resources.state string
suggestions array of objects Suggested matches based on name similarity.
suggestions.resource_uuid string (uuid)
suggestions.resource_name string
suggestions.license_reference string
suggestions.license_name string
suggestions.confidence number (double) Confidence score (0-1) based on name similarity.
error string

Fetch fresh consumption and billing data from Arrow API for this customer

Fetch fresh consumption and billing data from Arrow API for this customer.

1
2
3
4
http \
  GET \
  https://api.example.com/api/admin/arrow/customer-mappings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/fetch_arrow_data/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.admin import admin_arrow_customer_mappings_fetch_arrow_data_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = admin_arrow_customer_mappings_fetch_arrow_data_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: admin_arrow_customer_mappings_fetch_arrow_data_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { adminArrowCustomerMappingsFetchArrowDataRetrieve } from 'waldur-js-client';

try {
  const response = await adminArrowCustomerMappingsFetchArrowDataRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
customer_mapping_uuid string (uuid)
arrow_reference string
arrow_company_name string
waldur_customer_name string
period string
billing_available boolean
billing_lines array of objects
billing_lines.vendor_name string
billing_lines.subscription_reference string
billing_lines.license_reference string Arrow license reference. Used to fetch consumption data.
billing_lines.offer_sku string
billing_lines.classification string
billing_lines.quantity string (decimal)
billing_lines.sell_price string (decimal)
billing_lines.buy_price string (decimal)
billing_total_sell string (decimal)
billing_total_buy string (decimal)
consumption_lines array of objects
consumption_lines.license_reference string Arrow license reference (same as resource backend_id).
consumption_lines.resource_name string
consumption_lines.resource_uuid string UUID of the Waldur resource.
consumption_lines.period string
consumption_lines.sell_price string (decimal)
consumption_lines.buy_price string (decimal)
consumption_lines.error string Error message if fetch failed.
consumption_total_sell string (decimal)
consumption_total_buy string (decimal)
total_customer_resources integer Total number of resources for this customer in Waldur.
resources_with_backend_id integer Number of resources with backend_id set (Arrow license reference).
matched_resources integer Number of resources for which consumption was successfully fetched.
error string

Sync & Management

Import an Arrow license as a new Waldur resource

Import an Arrow license as a new Waldur resource.

1
2
3
4
5
6
7
http \
  POST \
  https://api.example.com/api/admin/arrow/customer-mappings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/import_license/ \
  Authorization:"Token YOUR_API_TOKEN" \
  license_reference="string-value" \
  offering_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  project_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.import_license_request_request import ImportLicenseRequestRequest # (1)
from waldur_api_client.api.admin import admin_arrow_customer_mappings_import_license # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ImportLicenseRequestRequest(
    license_reference="string-value",
    offering_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    project_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
)
response = admin_arrow_customer_mappings_import_license.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ImportLicenseRequestRequest
  2. API Source: admin_arrow_customer_mappings_import_license
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
import { adminArrowCustomerMappingsImportLicense } from 'waldur-js-client';

try {
  const response = await adminArrowCustomerMappingsImportLicense({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "license_reference": "string-value",
    "offering_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "project_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
license_reference string ✓ Arrow license reference (e.g., XSP12345). Will be set as backend_id.
license_name string Name for the new resource. Defaults to license_reference if not provided.
offering_uuid string (uuid) ✓ UUID of the Waldur offering to create the resource under.
project_uuid string (uuid) ✓ UUID of the project to create the resource in.

200 -

Field Type
resource_uuid string (uuid)
resource_name string
license_reference string
offering_name string
project_name string
success boolean

Link a Waldur resource to an Arrow license by setting its backend_id.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/admin/arrow/customer-mappings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/link_resource/ \
  Authorization:"Token YOUR_API_TOKEN" \
  resource_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  license_reference="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.link_resource_request_request import LinkResourceRequestRequest # (1)
from waldur_api_client.api.admin import admin_arrow_customer_mappings_link_resource # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = LinkResourceRequestRequest(
    resource_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    license_reference="string-value"
)
response = admin_arrow_customer_mappings_link_resource.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: LinkResourceRequestRequest
  2. API Source: admin_arrow_customer_mappings_link_resource
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { adminArrowCustomerMappingsLinkResource } from 'waldur-js-client';

try {
  const response = await adminArrowCustomerMappingsLinkResource({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "resource_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "license_reference": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
resource_uuid string (uuid) ✓ UUID of the Waldur resource to link.
license_reference string ✓ Arrow license reference to set as backend_id (e.g., XSP12345).

200 -

Field Type
resource_uuid string (uuid)
resource_name string
license_reference string
previous_backend_id string
success boolean

Sync customer list from Arrow and update arrow_company_name

Sync customer list from Arrow and update arrow_company_name.

1
2
3
4
http \
  POST \
  https://api.example.com/api/admin/arrow/customer-mappings/sync_from_arrow/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.sync_from_arrow_request_request import SyncFromArrowRequestRequest # (1)
from waldur_api_client.api.admin import admin_arrow_customer_mappings_sync_from_arrow # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = SyncFromArrowRequestRequest()
response = admin_arrow_customer_mappings_sync_from_arrow.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: SyncFromArrowRequestRequest
  2. API Source: admin_arrow_customer_mappings_sync_from_arrow
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { adminArrowCustomerMappingsSyncFromArrow } from 'waldur-js-client';

try {
  const response = await adminArrowCustomerMappingsSyncFromArrow({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required
settings_uuid string (uuid)

200 - No response body

Other Actions

Customer mappings

1
2
3
4
5
6
7
http \
  POST \
  https://api.example.com/api/admin/arrow/customer-mappings/ \
  Authorization:"Token YOUR_API_TOKEN" \
  settings="a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  arrow_reference="string-value" \
  waldur_customer="a1b2c3d4-e5f6-7890-abcd-ef1234567890"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.arrow_customer_mapping_create_request import ArrowCustomerMappingCreateRequest # (1)
from waldur_api_client.api.admin import admin_arrow_customer_mappings_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ArrowCustomerMappingCreateRequest(
    settings="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    arrow_reference="string-value",
    waldur_customer="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
)
response = admin_arrow_customer_mappings_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ArrowCustomerMappingCreateRequest
  2. API Source: admin_arrow_customer_mappings_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
import { adminArrowCustomerMappingsCreate } from 'waldur-js-client';

try {
  const response = await adminArrowCustomerMappingsCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "settings": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "arrow_reference": "string-value",
    "waldur_customer": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
settings string (uuid) ✓
arrow_reference string ✓ Arrow customer ID (e.g., 'XSP661245')
arrow_company_name string Arrow company name
waldur_customer string (uuid) ✓
is_active boolean Whether this mapping is active

201 -

Field Type Description
uuid string (uuid)
url string (uri)
settings string (uuid)
settings_uuid string (uuid)
arrow_reference string Arrow customer ID (e.g., 'XSP661245')
arrow_company_name string Arrow company name
waldur_customer string (uuid)
waldur_customer_uuid string (uuid)
waldur_customer_name string
is_active boolean Whether this mapping is active
created string (date-time)
modified string (date-time)

Update

1
2
3
4
5
6
7
http \
  PUT \
  https://api.example.com/api/admin/arrow/customer-mappings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  settings="https://api.example.com/api/settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  arrow_reference="string-value" \
  waldur_customer="https://api.example.com/api/waldur-customer/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.arrow_customer_mapping_request import ArrowCustomerMappingRequest # (1)
from waldur_api_client.api.admin import admin_arrow_customer_mappings_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ArrowCustomerMappingRequest(
    settings="https://api.example.com/api/settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    arrow_reference="string-value",
    waldur_customer="https://api.example.com/api/waldur-customer/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = admin_arrow_customer_mappings_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ArrowCustomerMappingRequest
  2. API Source: admin_arrow_customer_mappings_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
import { adminArrowCustomerMappingsUpdate } from 'waldur-js-client';

try {
  const response = await adminArrowCustomerMappingsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "settings": "https://api.example.com/api/settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "arrow_reference": "string-value",
    "waldur_customer": "https://api.example.com/api/waldur-customer/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
settings string (uri) ✓
arrow_reference string ✓ Arrow customer ID (e.g., 'XSP661245')
arrow_company_name string Arrow company name
waldur_customer string (uri) ✓
is_active boolean Whether this mapping is active

200 -

Field Type Description
uuid string (uuid)
url string (uri)
settings string (uri)
settings_uuid string (uuid)
arrow_reference string Arrow customer ID (e.g., 'XSP661245')
arrow_company_name string Arrow company name
waldur_customer string (uri)
waldur_customer_uuid string (uuid)
waldur_customer_name string
is_active boolean Whether this mapping is active
created string (date-time)
modified string (date-time)

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/admin/arrow/customer-mappings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_arrow_customer_mapping_request import PatchedArrowCustomerMappingRequest # (1)
from waldur_api_client.api.admin import admin_arrow_customer_mappings_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedArrowCustomerMappingRequest()
response = admin_arrow_customer_mappings_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedArrowCustomerMappingRequest
  2. API Source: admin_arrow_customer_mappings_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { adminArrowCustomerMappingsPartialUpdate } from 'waldur-js-client';

try {
  const response = await adminArrowCustomerMappingsPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
settings string (uri)
arrow_reference string Arrow customer ID (e.g., 'XSP661245')
arrow_company_name string Arrow company name
waldur_customer string (uri)
is_active boolean Whether this mapping is active

200 -

Field Type Description
uuid string (uuid)
url string (uri)
settings string (uri)
settings_uuid string (uuid)
arrow_reference string Arrow customer ID (e.g., 'XSP661245')
arrow_company_name string Arrow company name
waldur_customer string (uri)
waldur_customer_uuid string (uuid)
waldur_customer_name string
is_active boolean Whether this mapping is active
created string (date-time)
modified string (date-time)

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/admin/arrow/customer-mappings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.admin import admin_arrow_customer_mappings_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = admin_arrow_customer_mappings_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: admin_arrow_customer_mappings_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { adminArrowCustomerMappingsDestroy } from 'waldur-js-client';

try {
  const response = await adminArrowCustomerMappingsDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Admin Arrow Settings

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/admin/arrow/settings/ List Admin Arrow Settings
GET /api/admin/arrow/settings/{uuid}/ Retrieve
Management
POST /api/admin/arrow/settings/discover_customers/ Discover Arrow customers and suggest mappings to Waldur customers
POST /api/admin/arrow/settings/preview_settings/ Preview settings configuration before saving
POST /api/admin/arrow/settings/save_settings/ Save Arrow settings and customer mappings
POST /api/admin/arrow/settings/validate_credentials/ Validate Arrow API credentials without saving them
Other Actions
POST /api/admin/arrow/settings/ Create
PUT /api/admin/arrow/settings/{uuid}/ Update
PATCH /api/admin/arrow/settings/{uuid}/ Partial Update
DELETE /api/admin/arrow/settings/{uuid}/ Delete

Core CRUD

List Admin Arrow Settings

1
2
3
4
http \
  GET \
  https://api.example.com/api/admin/arrow/settings/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.admin import admin_arrow_settings_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = admin_arrow_settings_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: admin_arrow_settings_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { adminArrowSettingsList } from 'waldur-js-client';

try {
  const response = await adminArrowSettingsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
is_active boolean
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
sync_enabled boolean

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid)
url string (uri)
api_url string (uri) Arrow API base URL
api_key string Arrow API Key (leave empty on update to keep current)
export_type_reference string Billing export template reference
classification_filter string Filter for IaaS/SaaS classification
is_active boolean Whether this settings record is active
sync_enabled boolean Whether automatic billing sync is enabled
partner_reference string Arrow partner reference (discovered from API)
partner_name string Arrow partner name (discovered from API)
invoice_price_source any Which price to use for invoice items: sell or buy
invoice_item_prefix string Prefix for invoice item names (e.g. 'Arrow consumption')
created string (date-time)
modified string (date-time)

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/admin/arrow/settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.admin import admin_arrow_settings_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = admin_arrow_settings_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: admin_arrow_settings_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { adminArrowSettingsRetrieve } from 'waldur-js-client';

try {
  const response = await adminArrowSettingsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
uuid string (uuid)
url string (uri)
api_url string (uri) Arrow API base URL
api_key string Arrow API Key (leave empty on update to keep current)
export_type_reference string Billing export template reference
classification_filter string Filter for IaaS/SaaS classification
is_active boolean Whether this settings record is active
sync_enabled boolean Whether automatic billing sync is enabled
partner_reference string Arrow partner reference (discovered from API)
partner_name string Arrow partner name (discovered from API)
invoice_price_source any Which price to use for invoice items: sell or buy
invoice_item_prefix string Prefix for invoice item names (e.g. 'Arrow consumption')
created string (date-time)
modified string (date-time)

Management

Discover Arrow customers and suggest mappings to Waldur customers

Discover Arrow customers and suggest mappings to Waldur customers.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/admin/arrow/settings/discover_customers/ \
  Authorization:"Token YOUR_API_TOKEN" \
  api_url="https://api.example.com/api/api-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  api_key="********"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.discover_customers_request_request import DiscoverCustomersRequestRequest # (1)
from waldur_api_client.api.admin import admin_arrow_settings_discover_customers # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = DiscoverCustomersRequestRequest(
    api_url="https://api.example.com/api/api-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    api_key="********"
)
response = admin_arrow_settings_discover_customers.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: DiscoverCustomersRequestRequest
  2. API Source: admin_arrow_settings_discover_customers
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { adminArrowSettingsDiscoverCustomers } from 'waldur-js-client';

try {
  const response = await adminArrowSettingsDiscoverCustomers({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "api_url": "https://api.example.com/api/api-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "api_key": "********"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
api_url string (uri) ✓ Arrow API base URL
api_key string ✓ Arrow API Key

200 -

Field Type
arrow_customers array of objects
arrow_customers.reference string
arrow_customers.companyName string
arrow_customers.email string
arrow_customers.city string
arrow_customers.countryCode string
waldur_customers array of objects
waldur_customers.uuid string (uuid)
waldur_customers.name string
waldur_customers.abbreviation string
suggestions array of objects
suggestions.arrow_customer object
suggestions.arrow_customer.reference string
suggestions.arrow_customer.companyName string
suggestions.arrow_customer.email string
suggestions.arrow_customer.city string
suggestions.arrow_customer.countryCode string
suggestions.suggested_waldur_customer object
suggestions.suggested_waldur_customer.uuid string (uuid)
suggestions.suggested_waldur_customer.name string
suggestions.suggested_waldur_customer.abbreviation string
suggestions.confidence number (double)
suggestions.existing_mapping boolean
export_types array of objects
export_types.reference string
export_types.name string
export_types.required_fields_total integer
export_types.required_fields_found integer
export_types.important_fields_total integer
export_types.important_fields_found integer
export_types.missing_required_fields array of strings
export_types.missing_important_fields array of strings
export_types.compatible boolean
export_types.recommended boolean

Preview settings configuration before saving

Preview settings configuration before saving.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/admin/arrow/settings/preview_settings/ \
  Authorization:"Token YOUR_API_TOKEN" \
  api_url="https://api.example.com/api/api-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  api_key="********"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.preview_settings_request_request import PreviewSettingsRequestRequest # (1)
from waldur_api_client.api.admin import admin_arrow_settings_preview_settings # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PreviewSettingsRequestRequest(
    api_url="https://api.example.com/api/api-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    api_key="********"
)
response = admin_arrow_settings_preview_settings.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PreviewSettingsRequestRequest
  2. API Source: admin_arrow_settings_preview_settings
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { adminArrowSettingsPreviewSettings } from 'waldur-js-client';

try {
  const response = await adminArrowSettingsPreviewSettings({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "api_url": "https://api.example.com/api/api-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "api_key": "********"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
api_url string (uri) ✓ Arrow API base URL
api_key string ✓ Arrow API Key
export_type_reference string
classification_filter string
Constraints: default: IAAS
sync_enabled boolean
Constraints: default: False

200 -

Field Type
api_url string (uri)
partner_name string
partner_reference string
export_type_reference string
classification_filter string
sync_enabled boolean

Save Arrow settings and customer mappings

Save Arrow settings and customer mappings.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/admin/arrow/settings/save_settings/ \
  Authorization:"Token YOUR_API_TOKEN" \
  api_url="https://api.example.com/api/api-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  api_key="********"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.save_settings_request_request import SaveSettingsRequestRequest # (1)
from waldur_api_client.api.admin import admin_arrow_settings_save_settings # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = SaveSettingsRequestRequest(
    api_url="https://api.example.com/api/api-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    api_key="********"
)
response = admin_arrow_settings_save_settings.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: SaveSettingsRequestRequest
  2. API Source: admin_arrow_settings_save_settings
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { adminArrowSettingsSaveSettings } from 'waldur-js-client';

try {
  const response = await adminArrowSettingsSaveSettings({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "api_url": "https://api.example.com/api/api-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "api_key": "********"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
api_url string (uri) ✓ Arrow API base URL
api_key string ✓ Arrow API Key
export_type_reference string
classification_filter string
Constraints: default: IAAS
sync_enabled boolean
Constraints: default: False
customer_mappings array of objects
customer_mappings.arrow_reference string ✓
customer_mappings.waldur_customer_uuid string (uuid) ✓

201 -

Field Type
settings_uuid string (uuid)
mappings_created integer
message string

Validate Arrow API credentials without saving them

Validate Arrow API credentials without saving them.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/admin/arrow/settings/validate_credentials/ \
  Authorization:"Token YOUR_API_TOKEN" \
  api_url="https://api.example.com/api/api-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  api_key="********"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.arrow_credentials_request import ArrowCredentialsRequest # (1)
from waldur_api_client.api.admin import admin_arrow_settings_validate_credentials # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ArrowCredentialsRequest(
    api_url="https://api.example.com/api/api-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    api_key="********"
)
response = admin_arrow_settings_validate_credentials.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ArrowCredentialsRequest
  2. API Source: admin_arrow_settings_validate_credentials
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { adminArrowSettingsValidateCredentials } from 'waldur-js-client';

try {
  const response = await adminArrowSettingsValidateCredentials({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "api_url": "https://api.example.com/api/api-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "api_key": "********"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
api_url string (uri) ✓ Arrow API base URL
api_key string ✓ Arrow API Key

200 -

Field Type
valid boolean
message string
error string
partner_info object (free-form)

Other Actions

Create

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/admin/arrow/settings/ \
  Authorization:"Token YOUR_API_TOKEN" \
  api_url="https://api.example.com/api/api-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  api_key="********"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.arrow_settings_create_request import ArrowSettingsCreateRequest # (1)
from waldur_api_client.api.admin import admin_arrow_settings_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ArrowSettingsCreateRequest(
    api_url="https://api.example.com/api/api-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    api_key="********"
)
response = admin_arrow_settings_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ArrowSettingsCreateRequest
  2. API Source: admin_arrow_settings_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { adminArrowSettingsCreate } from 'waldur-js-client';

try {
  const response = await adminArrowSettingsCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "api_url": "https://api.example.com/api/api-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "api_key": "********"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
api_url string (uri) ✓ Arrow API base URL
api_key string ✓ Arrow API Key (required for creation)
Constraints: write-only
export_type_reference string Billing export template reference
classification_filter string Filter for IaaS/SaaS classification
is_active boolean Whether this settings record is active
sync_enabled boolean Whether automatic billing sync is enabled
invoice_price_source any Which price to use for invoice items: sell or buy
invoice_item_prefix string Prefix for invoice item names (e.g. 'Arrow consumption')

201 -

Field Type Description
uuid string (uuid)
url string (uri)
api_url string (uri) Arrow API base URL
export_type_reference string Billing export template reference
classification_filter string Filter for IaaS/SaaS classification
is_active boolean Whether this settings record is active
sync_enabled boolean Whether automatic billing sync is enabled
partner_reference string Arrow partner reference (discovered from API)
partner_name string Arrow partner name (discovered from API)
invoice_price_source any Which price to use for invoice items: sell or buy
invoice_item_prefix string Prefix for invoice item names (e.g. 'Arrow consumption')
created string (date-time)
modified string (date-time)

Update

1
2
3
4
5
http \
  PUT \
  https://api.example.com/api/admin/arrow/settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  api_url="https://api.example.com/api/api-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.arrow_settings_request import ArrowSettingsRequest # (1)
from waldur_api_client.api.admin import admin_arrow_settings_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ArrowSettingsRequest(
    api_url="https://api.example.com/api/api-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = admin_arrow_settings_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ArrowSettingsRequest
  2. API Source: admin_arrow_settings_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { adminArrowSettingsUpdate } from 'waldur-js-client';

try {
  const response = await adminArrowSettingsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "api_url": "https://api.example.com/api/api-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
api_url string (uri) ✓ Arrow API base URL
api_key string Arrow API Key (leave empty on update to keep current)
export_type_reference string Billing export template reference
classification_filter string Filter for IaaS/SaaS classification
is_active boolean Whether this settings record is active
sync_enabled boolean Whether automatic billing sync is enabled
invoice_price_source any Which price to use for invoice items: sell or buy
invoice_item_prefix string Prefix for invoice item names (e.g. 'Arrow consumption')

200 -

Field Type Description
uuid string (uuid)
url string (uri)
api_url string (uri) Arrow API base URL
api_key string Arrow API Key (leave empty on update to keep current)
export_type_reference string Billing export template reference
classification_filter string Filter for IaaS/SaaS classification
is_active boolean Whether this settings record is active
sync_enabled boolean Whether automatic billing sync is enabled
partner_reference string Arrow partner reference (discovered from API)
partner_name string Arrow partner name (discovered from API)
invoice_price_source any Which price to use for invoice items: sell or buy
invoice_item_prefix string Prefix for invoice item names (e.g. 'Arrow consumption')
created string (date-time)
modified string (date-time)

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/admin/arrow/settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_arrow_settings_request import PatchedArrowSettingsRequest # (1)
from waldur_api_client.api.admin import admin_arrow_settings_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedArrowSettingsRequest()
response = admin_arrow_settings_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedArrowSettingsRequest
  2. API Source: admin_arrow_settings_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { adminArrowSettingsPartialUpdate } from 'waldur-js-client';

try {
  const response = await adminArrowSettingsPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
api_url string (uri) Arrow API base URL
api_key string Arrow API Key (leave empty on update to keep current)
export_type_reference string Billing export template reference
classification_filter string Filter for IaaS/SaaS classification
is_active boolean Whether this settings record is active
sync_enabled boolean Whether automatic billing sync is enabled
invoice_price_source any Which price to use for invoice items: sell or buy
invoice_item_prefix string Prefix for invoice item names (e.g. 'Arrow consumption')

200 -

Field Type Description
uuid string (uuid)
url string (uri)
api_url string (uri) Arrow API base URL
api_key string Arrow API Key (leave empty on update to keep current)
export_type_reference string Billing export template reference
classification_filter string Filter for IaaS/SaaS classification
is_active boolean Whether this settings record is active
sync_enabled boolean Whether automatic billing sync is enabled
partner_reference string Arrow partner reference (discovered from API)
partner_name string Arrow partner name (discovered from API)
invoice_price_source any Which price to use for invoice items: sell or buy
invoice_item_prefix string Prefix for invoice item names (e.g. 'Arrow consumption')
created string (date-time)
modified string (date-time)

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/admin/arrow/settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.admin import admin_arrow_settings_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = admin_arrow_settings_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: admin_arrow_settings_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { adminArrowSettingsDestroy } from 'waldur-js-client';

try {
  const response = await adminArrowSettingsDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Admin Arrow Vendor Offering Mappings

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/admin/arrow/vendor-offering-mappings/ Vendor offering mappings
GET /api/admin/arrow/vendor-offering-mappings/{uuid}/ Retrieve
Data
GET /api/admin/arrow/vendor-offering-mappings/vendor_choices/ Get vendor names from Arrow catalog API (IAAS category)
Other Actions
POST /api/admin/arrow/vendor-offering-mappings/ Vendor offering mappings
PUT /api/admin/arrow/vendor-offering-mappings/{uuid}/ Update
PATCH /api/admin/arrow/vendor-offering-mappings/{uuid}/ Partial Update
DELETE /api/admin/arrow/vendor-offering-mappings/{uuid}/ Delete

Core CRUD

Vendor offering mappings

1
2
3
4
http \
  GET \
  https://api.example.com/api/admin/arrow/vendor-offering-mappings/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.admin import admin_arrow_vendor_offering_mappings_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = admin_arrow_vendor_offering_mappings_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: admin_arrow_vendor_offering_mappings_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { adminArrowVendorOfferingMappingsList } from 'waldur-js-client';

try {
  const response = await adminArrowVendorOfferingMappingsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
arrow_vendor_name string
is_active boolean
offering string (uri)
offering_uuid string (uuid)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
settings string (uri)
settings_uuid string (uuid)

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid)
url string (uri)
settings string (uri)
settings_uuid string (uuid)
arrow_vendor_name string Arrow vendor name (e.g., 'Microsoft', 'Amazon Web Services')
offering string (uuid)
offering_uuid string (uuid)
offering_name string
offering_type string
plan string (uuid)
plan_uuid string (uuid)
plan_name string
is_active boolean Whether this mapping is active
created string (date-time)
modified string (date-time)

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/admin/arrow/vendor-offering-mappings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.admin import admin_arrow_vendor_offering_mappings_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = admin_arrow_vendor_offering_mappings_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: admin_arrow_vendor_offering_mappings_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { adminArrowVendorOfferingMappingsRetrieve } from 'waldur-js-client';

try {
  const response = await adminArrowVendorOfferingMappingsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
uuid string (uuid)
url string (uri)
settings string (uri)
settings_uuid string (uuid)
arrow_vendor_name string Arrow vendor name (e.g., 'Microsoft', 'Amazon Web Services')
offering string (uuid)
offering_uuid string (uuid)
offering_name string
offering_type string
plan string (uuid)
plan_uuid string (uuid)
plan_name string
is_active boolean Whether this mapping is active
created string (date-time)
modified string (date-time)

Data

Get vendor names from Arrow catalog API (IAAS category)

Get vendor names from Arrow catalog API (IAAS category).

1
2
3
4
http \
  GET \
  https://api.example.com/api/admin/arrow/vendor-offering-mappings/vendor_choices/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.admin import admin_arrow_vendor_offering_mappings_vendor_choices_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = admin_arrow_vendor_offering_mappings_vendor_choices_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: admin_arrow_vendor_offering_mappings_vendor_choices_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { adminArrowVendorOfferingMappingsVendorChoicesList } from 'waldur-js-client';

try {
  const response = await adminArrowVendorOfferingMappingsVendorChoicesList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
arrow_vendor_name string
is_active boolean
offering string (uri)
offering_uuid string (uuid)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
settings string (uri)
settings_uuid string (uuid)

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
value string
label string

Other Actions

Vendor offering mappings

1
2
3
4
5
6
7
http \
  POST \
  https://api.example.com/api/admin/arrow/vendor-offering-mappings/ \
  Authorization:"Token YOUR_API_TOKEN" \
  settings="a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  arrow_vendor_name="string-value" \
  offering="a1b2c3d4-e5f6-7890-abcd-ef1234567890"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.arrow_vendor_offering_mapping_create_request import ArrowVendorOfferingMappingCreateRequest # (1)
from waldur_api_client.api.admin import admin_arrow_vendor_offering_mappings_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ArrowVendorOfferingMappingCreateRequest(
    settings="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    arrow_vendor_name="string-value",
    offering="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
)
response = admin_arrow_vendor_offering_mappings_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ArrowVendorOfferingMappingCreateRequest
  2. API Source: admin_arrow_vendor_offering_mappings_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
import { adminArrowVendorOfferingMappingsCreate } from 'waldur-js-client';

try {
  const response = await adminArrowVendorOfferingMappingsCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "settings": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "arrow_vendor_name": "string-value",
    "offering": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
settings string (uuid) ✓
arrow_vendor_name string ✓ Arrow vendor name (e.g., 'Microsoft', 'Amazon Web Services')
offering string (uuid) ✓
plan string (uuid)
is_active boolean Whether this mapping is active

201 -

Field Type Description
uuid string (uuid)
url string (uri)
settings string (uuid)
settings_uuid string (uuid)
arrow_vendor_name string Arrow vendor name (e.g., 'Microsoft', 'Amazon Web Services')
offering string (uuid)
offering_uuid string (uuid)
offering_name string
offering_type string
plan string (uuid)
plan_uuid string (uuid)
plan_name string
is_active boolean Whether this mapping is active
created string (date-time)
modified string (date-time)

Update

1
2
3
4
5
6
7
http \
  PUT \
  https://api.example.com/api/admin/arrow/vendor-offering-mappings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  settings="https://api.example.com/api/settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  arrow_vendor_name="string-value" \
  offering="a1b2c3d4-e5f6-7890-abcd-ef1234567890"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.arrow_vendor_offering_mapping_request import ArrowVendorOfferingMappingRequest # (1)
from waldur_api_client.api.admin import admin_arrow_vendor_offering_mappings_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ArrowVendorOfferingMappingRequest(
    settings="https://api.example.com/api/settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    arrow_vendor_name="string-value",
    offering="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
)
response = admin_arrow_vendor_offering_mappings_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ArrowVendorOfferingMappingRequest
  2. API Source: admin_arrow_vendor_offering_mappings_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
import { adminArrowVendorOfferingMappingsUpdate } from 'waldur-js-client';

try {
  const response = await adminArrowVendorOfferingMappingsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "settings": "https://api.example.com/api/settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "arrow_vendor_name": "string-value",
    "offering": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
settings string (uri) ✓
arrow_vendor_name string ✓ Arrow vendor name (e.g., 'Microsoft', 'Amazon Web Services')
offering string (uuid) ✓
plan string (uuid)
is_active boolean Whether this mapping is active

200 -

Field Type Description
uuid string (uuid)
url string (uri)
settings string (uri)
settings_uuid string (uuid)
arrow_vendor_name string Arrow vendor name (e.g., 'Microsoft', 'Amazon Web Services')
offering string (uuid)
offering_uuid string (uuid)
offering_name string
offering_type string
plan string (uuid)
plan_uuid string (uuid)
plan_name string
is_active boolean Whether this mapping is active
created string (date-time)
modified string (date-time)

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/admin/arrow/vendor-offering-mappings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_arrow_vendor_offering_mapping_request import PatchedArrowVendorOfferingMappingRequest # (1)
from waldur_api_client.api.admin import admin_arrow_vendor_offering_mappings_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedArrowVendorOfferingMappingRequest()
response = admin_arrow_vendor_offering_mappings_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedArrowVendorOfferingMappingRequest
  2. API Source: admin_arrow_vendor_offering_mappings_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { adminArrowVendorOfferingMappingsPartialUpdate } from 'waldur-js-client';

try {
  const response = await adminArrowVendorOfferingMappingsPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
settings string (uri)
arrow_vendor_name string Arrow vendor name (e.g., 'Microsoft', 'Amazon Web Services')
offering string (uuid)
plan string (uuid)
is_active boolean Whether this mapping is active

200 -

Field Type Description
uuid string (uuid)
url string (uri)
settings string (uri)
settings_uuid string (uuid)
arrow_vendor_name string Arrow vendor name (e.g., 'Microsoft', 'Amazon Web Services')
offering string (uuid)
offering_uuid string (uuid)
offering_name string
offering_type string
plan string (uuid)
plan_uuid string (uuid)
plan_name string
is_active boolean Whether this mapping is active
created string (date-time)
modified string (date-time)

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/admin/arrow/vendor-offering-mappings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.admin import admin_arrow_vendor_offering_mappings_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = admin_arrow_vendor_offering_mappings_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: admin_arrow_vendor_offering_mappings_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { adminArrowVendorOfferingMappingsDestroy } from 'waldur-js-client';

try {
  const response = await adminArrowVendorOfferingMappingsDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Automation

Autoprovisioning Rules

Operations Summary

Method Endpoint Description
GET /api/autoprovisioning-rules/ Manage autoprovisioning rules
GET /api/autoprovisioning-rules/{uuid}/ Manage autoprovisioning rules
POST /api/autoprovisioning-rules/ Manage autoprovisioning rules
PUT /api/autoprovisioning-rules/{uuid}/ Manage autoprovisioning rules
PATCH /api/autoprovisioning-rules/{uuid}/ Manage autoprovisioning rules
DELETE /api/autoprovisioning-rules/{uuid}/ Manage autoprovisioning rules

Manage autoprovisioning rules

Manage autoprovisioning rules.

1
2
3
4
http \
  GET \
  https://api.example.com/api/autoprovisioning-rules/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.autoprovisioning_rules import autoprovisioning_rules_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = autoprovisioning_rules_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: autoprovisioning_rules_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { autoprovisioningRulesList } from 'waldur-js-client';

try {
  const response = await autoprovisioningRulesList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
name string
uuid string (uuid)
url string (uri)
user_affiliations array of strings
user_email_patterns array of strings
customer string (uri)
customer_name string
customer_uuid string
use_user_organization_as_customer_name boolean
project_role string (uri)
project_role_display_name string
project_role_description string
plan string (uri)
plan_attributes object (free-form)
plan_limits object (free-form)
plan_name string
offering_name string
offering_uuid string (uuid)
category_title string
category_url string (uri)

Manage autoprovisioning rules

Manage autoprovisioning rules.

1
2
3
4
http \
  GET \
  https://api.example.com/api/autoprovisioning-rules/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.autoprovisioning_rules import autoprovisioning_rules_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = autoprovisioning_rules_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: autoprovisioning_rules_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { autoprovisioningRulesRetrieve } from 'waldur-js-client';

try {
  const response = await autoprovisioningRulesRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
name string
uuid string (uuid)
url string (uri)
user_affiliations array of strings
user_email_patterns array of strings
customer string (uri)
customer_name string
customer_uuid string
use_user_organization_as_customer_name boolean
project_role string (uri)
project_role_display_name string
project_role_description string
plan string (uri)
plan_attributes object (free-form)
plan_limits object (free-form)
plan_name string
offering_name string
offering_uuid string (uuid)
category_title string
category_url string (uri)

Manage autoprovisioning rules

Manage autoprovisioning rules.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/autoprovisioning-rules/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-autoprovisioning-rule"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.rule_request import RuleRequest # (1)
from waldur_api_client.api.autoprovisioning_rules import autoprovisioning_rules_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = RuleRequest(
    name="my-awesome-autoprovisioning-rule"
)
response = autoprovisioning_rules_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: RuleRequest
  2. API Source: autoprovisioning_rules_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { autoprovisioningRulesCreate } from 'waldur-js-client';

try {
  const response = await autoprovisioningRulesCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "name": "my-awesome-autoprovisioning-rule"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required
name string ✓
user_affiliations array of strings
user_email_patterns array of strings
customer string (uri)
use_user_organization_as_customer_name boolean
project_role string (uri)
project_role_name string
plan string (uri)
plan_attributes object (free-form)
plan_limits object (free-form)

201 -

Field Type
name string
uuid string (uuid)
url string (uri)
user_affiliations array of strings
user_email_patterns array of strings
customer string (uri)
customer_name string
customer_uuid string
use_user_organization_as_customer_name boolean
project_role string (uri)
project_role_display_name string
project_role_description string
plan string (uri)
plan_attributes object (free-form)
plan_limits object (free-form)
plan_name string
offering_name string
offering_uuid string (uuid)
category_title string
category_url string (uri)

Manage autoprovisioning rules

Manage autoprovisioning rules.

1
2
3
4
5
http \
  PUT \
  https://api.example.com/api/autoprovisioning-rules/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-autoprovisioning-rule"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.rule_request import RuleRequest # (1)
from waldur_api_client.api.autoprovisioning_rules import autoprovisioning_rules_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = RuleRequest(
    name="my-awesome-autoprovisioning-rule"
)
response = autoprovisioning_rules_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: RuleRequest
  2. API Source: autoprovisioning_rules_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { autoprovisioningRulesUpdate } from 'waldur-js-client';

try {
  const response = await autoprovisioningRulesUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-autoprovisioning-rule"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
name string ✓
user_affiliations array of strings
user_email_patterns array of strings
customer string (uri)
use_user_organization_as_customer_name boolean
project_role string (uri)
project_role_name string
plan string (uri)
plan_attributes object (free-form)
plan_limits object (free-form)

200 -

Field Type
name string
uuid string (uuid)
url string (uri)
user_affiliations array of strings
user_email_patterns array of strings
customer string (uri)
customer_name string
customer_uuid string
use_user_organization_as_customer_name boolean
project_role string (uri)
project_role_display_name string
project_role_description string
plan string (uri)
plan_attributes object (free-form)
plan_limits object (free-form)
plan_name string
offering_name string
offering_uuid string (uuid)
category_title string
category_url string (uri)

Manage autoprovisioning rules

Manage autoprovisioning rules.

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/autoprovisioning-rules/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_rule_request import PatchedRuleRequest # (1)
from waldur_api_client.api.autoprovisioning_rules import autoprovisioning_rules_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedRuleRequest()
response = autoprovisioning_rules_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedRuleRequest
  2. API Source: autoprovisioning_rules_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { autoprovisioningRulesPartialUpdate } from 'waldur-js-client';

try {
  const response = await autoprovisioningRulesPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
name string
user_affiliations array of strings
user_email_patterns array of strings
customer string (uri)
use_user_organization_as_customer_name boolean
project_role string (uri)
project_role_name string
plan string (uri)
plan_attributes object (free-form)
plan_limits object (free-form)

200 -

Field Type
name string
uuid string (uuid)
url string (uri)
user_affiliations array of strings
user_email_patterns array of strings
customer string (uri)
customer_name string
customer_uuid string
use_user_organization_as_customer_name boolean
project_role string (uri)
project_role_display_name string
project_role_description string
plan string (uri)
plan_attributes object (free-form)
plan_limits object (free-form)
plan_name string
offering_name string
offering_uuid string (uuid)
category_title string
category_url string (uri)

Manage autoprovisioning rules

Manage autoprovisioning rules.

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/autoprovisioning-rules/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.autoprovisioning_rules import autoprovisioning_rules_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = autoprovisioning_rules_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: autoprovisioning_rules_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { autoprovisioningRulesDestroy } from 'waldur-js-client';

try {
  const response = await autoprovisioningRulesDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Marketplace Script Async Dry Run

Operations Summary

Method Endpoint Description
GET /api/marketplace-script-async-dry-run/ List Marketplace Script Async Dry Run
GET /api/marketplace-script-async-dry-run/{uuid}/ Retrieve

List Marketplace Script Async Dry Run

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-script-async-dry-run/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_script_async_dry_run import marketplace_script_async_dry_run_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_script_async_dry_run_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: marketplace_script_async_dry_run_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceScriptAsyncDryRunList } from 'waldur-js-client';

try {
  const response = await marketplaceScriptAsyncDryRunList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
url string (uri)
uuid string (uuid)
order_attributes any
order_type string
order_offering string (uri)
state any
get_state_display string
output string
created string (date-time)

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-script-async-dry-run/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_script_async_dry_run import marketplace_script_async_dry_run_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_script_async_dry_run_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_script_async_dry_run_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceScriptAsyncDryRunRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceScriptAsyncDryRunRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
url string (uri)
uuid string (uuid)
order_attributes any
order_type string
order_offering string (uri)
state any
get_state_display string
output string
created string (date-time)

Marketplace Script Dry Run

Operations Summary

Method Endpoint Description
POST /api/marketplace-script-dry-run/{uuid}/async_run/ Async run
POST /api/marketplace-script-dry-run/{uuid}/run/ Run

Async run

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-script-dry-run/a1b2c3d4-e5f6-7890-abcd-ef1234567890/async_run/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.dry_run_request import DryRunRequest # (1)
from waldur_api_client.api.marketplace_script_dry_run import marketplace_script_dry_run_async_run # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = DryRunRequest()
response = marketplace_script_dry_run_async_run.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: DryRunRequest
  2. API Source: marketplace_script_dry_run_async_run
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceScriptDryRunAsyncRun } from 'waldur-js-client';

try {
  const response = await marketplaceScriptDryRunAsyncRun({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
plan string (uri)
type any
attributes any
order_offering string (uri)

200 -

Field Type Description
url string (uri)
uuid string (uuid)
created string (date-time)
name string
slug string URL-friendly identifier. Only editable by staff users.
description string
full_description string
privacy_policy_link string (uri)
access_url string (uri) Publicly accessible offering access URL
endpoints array of objects
endpoints.uuid string (uuid)
endpoints.name string
endpoints.url string URL of the access endpoint
software_catalogs array of objects
software_catalogs.uuid string (uuid)
software_catalogs.catalog any
software_catalogs.enabled_cpu_family any List of enabled CPU families: ['x86_64', 'aarch64']
software_catalogs.enabled_cpu_microarchitectures any List of enabled CPU microarchitectures: ['generic', 'zen3']
software_catalogs.package_count integer
software_catalogs.partition any
partitions array of objects
partitions.uuid string (uuid)
partitions.partition_name string Name of the SLURM partition
partitions.cpu_bind integer Default task binding policy (SLURM cpu_bind)
partitions.def_cpu_per_gpu integer Default CPUs allocated per GPU
partitions.max_cpus_per_node integer Maximum allocated CPUs per node
partitions.max_cpus_per_socket integer Maximum allocated CPUs per socket
partitions.def_mem_per_cpu integer (int64) Default memory per CPU in MB
partitions.def_mem_per_gpu integer (int64) Default memory per GPU in MB
partitions.def_mem_per_node integer (int64) Default memory per node in MB
partitions.max_mem_per_cpu integer (int64) Maximum memory per CPU in MB
partitions.max_mem_per_node integer (int64) Maximum memory per node in MB
partitions.default_time integer Default time limit in minutes
partitions.max_time integer Maximum time limit in minutes
partitions.grace_time integer Preemption grace time in seconds
partitions.max_nodes integer Maximum nodes per job
partitions.min_nodes integer Minimum nodes per job
partitions.exclusive_topo boolean Exclusive topology access required
partitions.exclusive_user boolean Exclusive user access required
partitions.priority_tier integer Priority tier for scheduling and preemption
partitions.qos string Quality of Service (QOS) name
partitions.req_resv boolean Require reservation for job allocation
roles array of objects
roles.uuid string (uuid)
roles.name string
roles.url string (uri)
customer string (uri)
customer_uuid string (uuid)
customer_name string
project string (uri)
project_uuid string (uuid)
project_name string
category string (uri)
category_uuid string (uuid)
category_title string
attributes object (free-form)
options any
resource_options any
components array of objects
components.uuid string (uuid)
components.billing_type string
Enum: fixed, usage, limit, one, few
components.type string Unique internal name of the measured unit, for example floating_ip.
components.name string Display name for the measured unit, for example, Floating IP.
components.description string
components.measured_unit string Unit of measurement, for example, GB.
components.unit_factor integer The conversion factor from backend units to measured_unit
components.limit_period any
components.limit_amount integer
components.article_code string
components.max_value integer
components.min_value integer
components.max_available_limit integer
components.is_boolean boolean
components.default_limit integer
components.factor integer
components.is_builtin boolean
components.is_prepaid boolean
components.overage_component string (uuid)
components.min_prepaid_duration integer
components.max_prepaid_duration integer
plugin_options any
state any
vendor_details string
getting_started string
integration_guide string
thumbnail string (uri)
order_count integer
plans array of objects
plans.url string (uri)
plans.uuid string (uuid)
plans.name string
plans.description string
plans.article_code string
plans.max_amount integer Maximum number of plans that could be active. Plan is disabled when maximum amount is reached.
plans.archived boolean Forbids creation of new resources.
plans.is_active boolean
plans.unit_price string (decimal)
plans.unit string
Enum: month, quarter, half_month, day, hour, quantity
plans.init_price number (double)
plans.switch_price number (double)
plans.backend_id string
plans.organization_groups array of objects
plans.organization_groups.uuid string (uuid)
plans.organization_groups.url string (uri)
plans.organization_groups.name string
plans.organization_groups.parent_uuid string (uuid) UUID of the parent organization group
plans.organization_groups.parent_name string Name of the parent organization group
plans.organization_groups.parent string (uri)
plans.organization_groups.customers_count integer Number of customers in this organization group
plans.components array of objects
plans.components.type string Unique internal name of the measured unit, for example floating_ip.
plans.components.name string Display name for the measured unit, for example, Floating IP.
plans.components.measured_unit string Unit of measurement, for example, GB.
plans.components.amount integer
plans.components.price string (decimal)
plans.components.future_price string (decimal)
plans.components.discount_threshold integer Minimum amount to be eligible for discount.
plans.components.discount_rate integer Discount rate in percentage.
plans.prices object (free-form)
plans.future_prices object (free-form)
plans.quotas object (free-form)
plans.resources_count integer
plans.plan_type string
plans.minimal_price number (double)
screenshots array of objects
screenshots.name string
screenshots.uuid string (uuid)
screenshots.description string
screenshots.image string (uri)
screenshots.thumbnail string (uri)
screenshots.created string (date-time)
type string
shared boolean Accessible to all customers.
billable boolean Purchase and usage is invoiced.
scope string
scope_uuid string (uuid)
scope_name string (uuid)
scope_state any
scope_error_message string
files array of objects
files.name string
files.created string (date-time)
files.file string (uri)
quotas array of objects
quotas.name string
quotas.usage integer
quotas.limit integer
paused_reason string
datacite_doi string
citation_count integer Number of citations of a DOI
latitude number (double)
longitude number (double)
country any Country code (ISO 3166-1 alpha-2)
backend_id string
organization_groups array of objects
organization_groups.uuid string (uuid)
organization_groups.url string (uri)
organization_groups.name string
organization_groups.parent_uuid string (uuid) UUID of the parent organization group
organization_groups.parent_name string Name of the parent organization group
organization_groups.parent string (uri)
organization_groups.customers_count integer Number of customers in this organization group
tags array of objects
tags.uuid string (uuid)
tags.name string
image string (uri)
total_customers integer
total_cost integer
total_cost_estimated integer
parent_description string
parent_uuid string (uuid)
parent_name string
backend_metadata any
has_compliance_requirements boolean
billing_type_classification string Classify offering components by billing type. Returns 'limit_only', 'usage_only', or 'mixed'.
compliance_checklist string (uri)
user_has_consent boolean
is_accessible boolean
google_calendar_is_public boolean
google_calendar_link string Get the Google Calendar link for an offering.
promotion_campaigns array of objects
promotion_campaigns.uuid string (uuid)
promotion_campaigns.name string
promotion_campaigns.start_date string (date) Starting from this date, the campaign is active.
promotion_campaigns.end_date string (date) The last day the campaign is active.
promotion_campaigns.discount_type string
Enum: discount, special_price
promotion_campaigns.discount integer
promotion_campaigns.stock integer
promotion_campaigns.description string
promotion_campaigns.months integer How many months in a row should the related service (when activated) get special deal (0 for indefinitely until active)
promotion_campaigns.service_provider string (uri)

Run

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-script-dry-run/a1b2c3d4-e5f6-7890-abcd-ef1234567890/run/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.dry_run_request import DryRunRequest # (1)
from waldur_api_client.api.marketplace_script_dry_run import marketplace_script_dry_run_run # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = DryRunRequest()
response = marketplace_script_dry_run_run.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: DryRunRequest
  2. API Source: marketplace_script_dry_run_run
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceScriptDryRunRun } from 'waldur-js-client';

try {
  const response = await marketplaceScriptDryRunRun({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
plan string (uri)
type any
attributes any
order_offering string (uri)

200 -

Field Type Description
url string (uri)
uuid string (uuid)
created string (date-time)
name string
slug string URL-friendly identifier. Only editable by staff users.
description string
full_description string
privacy_policy_link string (uri)
access_url string (uri) Publicly accessible offering access URL
endpoints array of objects
endpoints.uuid string (uuid)
endpoints.name string
endpoints.url string URL of the access endpoint
software_catalogs array of objects
software_catalogs.uuid string (uuid)
software_catalogs.catalog any
software_catalogs.enabled_cpu_family any List of enabled CPU families: ['x86_64', 'aarch64']
software_catalogs.enabled_cpu_microarchitectures any List of enabled CPU microarchitectures: ['generic', 'zen3']
software_catalogs.package_count integer
software_catalogs.partition any
partitions array of objects
partitions.uuid string (uuid)
partitions.partition_name string Name of the SLURM partition
partitions.cpu_bind integer Default task binding policy (SLURM cpu_bind)
partitions.def_cpu_per_gpu integer Default CPUs allocated per GPU
partitions.max_cpus_per_node integer Maximum allocated CPUs per node
partitions.max_cpus_per_socket integer Maximum allocated CPUs per socket
partitions.def_mem_per_cpu integer (int64) Default memory per CPU in MB
partitions.def_mem_per_gpu integer (int64) Default memory per GPU in MB
partitions.def_mem_per_node integer (int64) Default memory per node in MB
partitions.max_mem_per_cpu integer (int64) Maximum memory per CPU in MB
partitions.max_mem_per_node integer (int64) Maximum memory per node in MB
partitions.default_time integer Default time limit in minutes
partitions.max_time integer Maximum time limit in minutes
partitions.grace_time integer Preemption grace time in seconds
partitions.max_nodes integer Maximum nodes per job
partitions.min_nodes integer Minimum nodes per job
partitions.exclusive_topo boolean Exclusive topology access required
partitions.exclusive_user boolean Exclusive user access required
partitions.priority_tier integer Priority tier for scheduling and preemption
partitions.qos string Quality of Service (QOS) name
partitions.req_resv boolean Require reservation for job allocation
roles array of objects
roles.uuid string (uuid)
roles.name string
roles.url string (uri)
customer string (uri)
customer_uuid string (uuid)
customer_name string
project string (uri)
project_uuid string (uuid)
project_name string
category string (uri)
category_uuid string (uuid)
category_title string
attributes object (free-form)
options any
resource_options any
components array of objects
components.uuid string (uuid)
components.billing_type string
Enum: fixed, usage, limit, one, few
components.type string Unique internal name of the measured unit, for example floating_ip.
components.name string Display name for the measured unit, for example, Floating IP.
components.description string
components.measured_unit string Unit of measurement, for example, GB.
components.unit_factor integer The conversion factor from backend units to measured_unit
components.limit_period any
components.limit_amount integer
components.article_code string
components.max_value integer
components.min_value integer
components.max_available_limit integer
components.is_boolean boolean
components.default_limit integer
components.factor integer
components.is_builtin boolean
components.is_prepaid boolean
components.overage_component string (uuid)
components.min_prepaid_duration integer
components.max_prepaid_duration integer
plugin_options any
state any
vendor_details string
getting_started string
integration_guide string
thumbnail string (uri)
order_count integer
plans array of objects
plans.url string (uri)
plans.uuid string (uuid)
plans.name string
plans.description string
plans.article_code string
plans.max_amount integer Maximum number of plans that could be active. Plan is disabled when maximum amount is reached.
plans.archived boolean Forbids creation of new resources.
plans.is_active boolean
plans.unit_price string (decimal)
plans.unit string
Enum: month, quarter, half_month, day, hour, quantity
plans.init_price number (double)
plans.switch_price number (double)
plans.backend_id string
plans.organization_groups array of objects
plans.organization_groups.uuid string (uuid)
plans.organization_groups.url string (uri)
plans.organization_groups.name string
plans.organization_groups.parent_uuid string (uuid) UUID of the parent organization group
plans.organization_groups.parent_name string Name of the parent organization group
plans.organization_groups.parent string (uri)
plans.organization_groups.customers_count integer Number of customers in this organization group
plans.components array of objects
plans.components.type string Unique internal name of the measured unit, for example floating_ip.
plans.components.name string Display name for the measured unit, for example, Floating IP.
plans.components.measured_unit string Unit of measurement, for example, GB.
plans.components.amount integer
plans.components.price string (decimal)
plans.components.future_price string (decimal)
plans.components.discount_threshold integer Minimum amount to be eligible for discount.
plans.components.discount_rate integer Discount rate in percentage.
plans.prices object (free-form)
plans.future_prices object (free-form)
plans.quotas object (free-form)
plans.resources_count integer
plans.plan_type string
plans.minimal_price number (double)
screenshots array of objects
screenshots.name string
screenshots.uuid string (uuid)
screenshots.description string
screenshots.image string (uri)
screenshots.thumbnail string (uri)
screenshots.created string (date-time)
type string
shared boolean Accessible to all customers.
billable boolean Purchase and usage is invoiced.
scope string
scope_uuid string (uuid)
scope_name string (uuid)
scope_state any
scope_error_message string
files array of objects
files.name string
files.created string (date-time)
files.file string (uri)
quotas array of objects
quotas.name string
quotas.usage integer
quotas.limit integer
paused_reason string
datacite_doi string
citation_count integer Number of citations of a DOI
latitude number (double)
longitude number (double)
country any Country code (ISO 3166-1 alpha-2)
backend_id string
organization_groups array of objects
organization_groups.uuid string (uuid)
organization_groups.url string (uri)
organization_groups.name string
organization_groups.parent_uuid string (uuid) UUID of the parent organization group
organization_groups.parent_name string Name of the parent organization group
organization_groups.parent string (uri)
organization_groups.customers_count integer Number of customers in this organization group
tags array of objects
tags.uuid string (uuid)
tags.name string
image string (uri)
total_customers integer
total_cost integer
total_cost_estimated integer
parent_description string
parent_uuid string (uuid)
parent_name string
backend_metadata any
has_compliance_requirements boolean
billing_type_classification string Classify offering components by billing type. Returns 'limit_only', 'usage_only', or 'mixed'.
compliance_checklist string (uri)
user_has_consent boolean
is_accessible boolean
google_calendar_is_public boolean
google_calendar_link string Get the Google Calendar link for an offering.
promotion_campaigns array of objects
promotion_campaigns.uuid string (uuid)
promotion_campaigns.name string
promotion_campaigns.start_date string (date) Starting from this date, the campaign is active.
promotion_campaigns.end_date string (date) The last day the campaign is active.
promotion_campaigns.discount_type string
Enum: discount, special_price
promotion_campaigns.discount integer
promotion_campaigns.stock integer
promotion_campaigns.description string
promotion_campaigns.months integer How many months in a row should the related service (when activated) get special deal (0 for indefinitely until active)
promotion_campaigns.service_provider string (uri)

Marketplace Script Sync Resource

Operations Summary

Method Endpoint Description
POST /api/marketplace-script-sync-resource/ Pull a marketplace script resource

Pull a marketplace script resource

Pull a marketplace script resource.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/marketplace-script-sync-resource/ \
  Authorization:"Token YOUR_API_TOKEN" \
  resource_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.pull_marketplace_script_resource_request import PullMarketplaceScriptResourceRequest # (1)
from waldur_api_client.api.marketplace_script_sync_resource import marketplace_script_sync_resource # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PullMarketplaceScriptResourceRequest(
    resource_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
)
response = marketplace_script_sync_resource.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PullMarketplaceScriptResourceRequest
  2. API Source: marketplace_script_sync_resource
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceScriptSyncResource } from 'waldur-js-client';

try {
  const response = await marketplaceScriptSyncResource({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "resource_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required
resource_uuid string (uuid) ✓

202 - No response body

404 - No response body

User Action Executions

Operations Summary

Method Endpoint Description
GET /api/user-action-executions/ List User Action Executions
GET /api/user-action-executions/{id}/ Retrieve

List User Action Executions

1
2
3
4
http \
  GET \
  https://api.example.com/api/user-action-executions/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.user_action_executions import user_action_executions_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = user_action_executions_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: user_action_executions_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { userActionExecutionsList } from 'waldur-js-client';

try {
  const response = await userActionExecutionsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
o string Which field to use when ordering the results.
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
id integer
corrective_action_label string
executed_at string (date-time)
success boolean
error_message string
execution_metadata string

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/user-action-executions/123/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.user_action_executions import user_action_executions_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = user_action_executions_retrieve.sync(
    id=123,
    client=client
)

print(response)
  1. API Source: user_action_executions_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { userActionExecutionsRetrieve } from 'waldur-js-client';

try {
  const response = await userActionExecutionsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "id": 123
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
id integer ✓ A unique integer value identifying this user action execution.

200 -

Field Type
id integer
corrective_action_label string
executed_at string (date-time)
success boolean
error_message string
execution_metadata string

User Action Providers

Operations Summary

Method Endpoint Description
GET /api/user-action-providers/ List User Action Providers
GET /api/user-action-providers/{id}/ Retrieve

List User Action Providers

1
2
3
4
http \
  GET \
  https://api.example.com/api/user-action-providers/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.user_action_providers import user_action_providers_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = user_action_providers_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: user_action_providers_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { userActionProvidersList } from 'waldur-js-client';

try {
  const response = await userActionProvidersList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
id integer
app_name string
provider_class string
action_type string
is_enabled boolean
schedule string
last_execution string (date-time)
last_execution_status string

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/user-action-providers/123/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.user_action_providers import user_action_providers_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = user_action_providers_retrieve.sync(
    id=123,
    client=client
)

print(response)
  1. API Source: user_action_providers_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { userActionProvidersRetrieve } from 'waldur-js-client';

try {
  const response = await userActionProvidersRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "id": 123
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
id integer ✓ A unique integer value identifying this user action provider.

200 -

Field Type
id integer
app_name string
provider_class string
action_type string
is_enabled boolean
schedule string
last_execution string (date-time)
last_execution_status string

User Actions

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/user-actions/ List User Actions
GET /api/user-actions/{uuid}/ Retrieve
POST /api/user-actions/update_actions/ Trigger update of user actions
Other Actions
GET /api/user-actions/summary/ Get action summary counts
POST /api/user-actions/bulk_silence/ Bulk silence actions by filters
POST /api/user-actions/{uuid}/execute_action/ Execute a corrective action
POST /api/user-actions/{uuid}/silence/ Silence an action temporarily or permanently
POST /api/user-actions/{uuid}/unsilence/ Remove silence from an action

Core CRUD

List User Actions

1
2
3
4
http \
  GET \
  https://api.example.com/api/user-actions/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.urgency_enum import UrgencyEnum # (1)
from waldur_api_client.api.user_actions import user_actions_list # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = user_actions_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: UrgencyEnum
  2. API Source: user_actions_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { userActionsList } from 'waldur-js-client';

try {
  const response = await userActionsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
action_type string
created_after string (date-time)
created_before string (date-time)
due_within_days number
include_silenced boolean
is_silenced boolean
o string Which field to use when ordering the results.
overdue boolean
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
urgency string Enum: low, medium, high
user_uuid string (uuid) Filter by user UUID (staff only).

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid)
action_type string Type of action, e.g. 'pending_order', 'expiring_resource'
title string
description string
urgency string
Enum: low, medium, high
due_date string (date-time)
is_silenced boolean
silenced_until string (date-time)
is_temporarily_silenced boolean
is_effectively_silenced boolean
created string (date-time)
modified string (date-time)
related_object_name string
related_object_type string
corrective_actions array of objects
corrective_actions.label string
corrective_actions.category string
Enum: view, approve, reject, extend, terminate, backup, migrate, contact, escalate, configure, repair, monitor
corrective_actions.severity string
Enum: safe, low, medium, high, critical
corrective_actions.method string
corrective_actions.api_endpoint boolean
corrective_actions.confirmation_required boolean
corrective_actions.permissions_required array of strings
corrective_actions.metadata object (free-form)
corrective_actions.route_name string
corrective_actions.route_params object (free-form)
days_until_due integer
route_name string UI-Router state name for navigation
route_params object (free-form)
project_name string
project_uuid string (uuid)
organization_name string
organization_uuid string (uuid)
offering_name string
offering_uuid string (uuid)
offering_type string
resource_name string
resource_uuid string (uuid)
order_type string

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/user-actions/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.user_actions import user_actions_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = user_actions_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: user_actions_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { userActionsRetrieve } from 'waldur-js-client';

try {
  const response = await userActionsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
uuid string (uuid)
action_type string Type of action, e.g. 'pending_order', 'expiring_resource'
title string
description string
urgency string
Enum: low, medium, high
due_date string (date-time)
is_silenced boolean
silenced_until string (date-time)
is_temporarily_silenced boolean
is_effectively_silenced boolean
created string (date-time)
modified string (date-time)
related_object_name string
related_object_type string
corrective_actions array of objects
corrective_actions.label string
corrective_actions.category string
Enum: view, approve, reject, extend, terminate, backup, migrate, contact, escalate, configure, repair, monitor
corrective_actions.severity string
Enum: safe, low, medium, high, critical
corrective_actions.method string
corrective_actions.api_endpoint boolean
corrective_actions.confirmation_required boolean
corrective_actions.permissions_required array of strings
corrective_actions.metadata object (free-form)
corrective_actions.route_name string
corrective_actions.route_params object (free-form)
days_until_due integer
route_name string UI-Router state name for navigation
route_params object (free-form)
project_name string
project_uuid string (uuid)
organization_name string
organization_uuid string (uuid)
offering_name string
offering_uuid string (uuid)
offering_type string
resource_name string
resource_uuid string (uuid)
order_type string

Trigger update of user actions

Trigger update of user actions

1
2
3
4
http \
  POST \
  https://api.example.com/api/user-actions/update_actions/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.update_actions_request import UpdateActionsRequest # (1)
from waldur_api_client.api.user_actions import user_actions_update_actions # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = UpdateActionsRequest()
response = user_actions_update_actions.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: UpdateActionsRequest
  2. API Source: user_actions_update_actions
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { userActionsUpdateActions } from 'waldur-js-client';

try {
  const response = await userActionsUpdateActions({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
provider_action_type string Optional provider action type to update. If not provided, updates all providers.

202 -

Field Type
status string
message string
provider_action_type string

Other Actions

Get action summary counts

Get action summary counts

1
2
3
4
http \
  GET \
  https://api.example.com/api/user-actions/summary/ \
  Authorization:"Token YOUR_API_TOKEN"

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.user_actions import user_actions_summary_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = user_actions_summary_retrieve.sync(client=client)

print(response)
  1. API Source: user_actions_summary_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { userActionsSummaryRetrieve } from 'waldur-js-client';

try {
  const response = await userActionsSummaryRetrieve({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

200 -

Field Type
total integer
by_urgency object (free-form)
by_type object (free-form)
overdue integer

Bulk silence actions by filters

Bulk silence actions by filters

1
2
3
4
http \
  POST \
  https://api.example.com/api/user-actions/bulk_silence/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.silence_action_request import SilenceActionRequest # (1)
from waldur_api_client.api.user_actions import user_actions_bulk_silence # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = SilenceActionRequest()
response = user_actions_bulk_silence.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: SilenceActionRequest
  2. API Source: user_actions_bulk_silence
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { userActionsBulkSilence } from 'waldur-js-client';

try {
  const response = await userActionsBulkSilence({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
duration_days integer Duration in days to silence the action. If not provided, silences permanently.

200 -

Field Type
status string
count integer
duration_days integer

Execute a corrective action

Execute a corrective action

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/user-actions/a1b2c3d4-e5f6-7890-abcd-ef1234567890/execute_action/ \
  Authorization:"Token YOUR_API_TOKEN" \
  action_label="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.execute_action_request import ExecuteActionRequest # (1)
from waldur_api_client.api.user_actions import user_actions_execute_action # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ExecuteActionRequest(
    action_label="string-value"
)
response = user_actions_execute_action.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ExecuteActionRequest
  2. API Source: user_actions_execute_action
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { userActionsExecuteAction } from 'waldur-js-client';

try {
  const response = await userActionsExecuteAction({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "action_label": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
action_label string ✓ Label of the corrective action to execute

200 -

Field Type
action string
message string
redirect_url string (uri)
metadata object (free-form)

404 -

Field Type
error string

500 -

Field Type
error string

Silence an action temporarily or permanently

Silence an action temporarily or permanently

1
2
3
4
http \
  POST \
  https://api.example.com/api/user-actions/a1b2c3d4-e5f6-7890-abcd-ef1234567890/silence/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.silence_action_request import SilenceActionRequest # (1)
from waldur_api_client.api.user_actions import user_actions_silence # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = SilenceActionRequest()
response = user_actions_silence.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: SilenceActionRequest
  2. API Source: user_actions_silence
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { userActionsSilence } from 'waldur-js-client';

try {
  const response = await userActionsSilence({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
duration_days integer Duration in days to silence the action. If not provided, silences permanently.

200 -

Field Type
status string
duration_days integer

Remove silence from an action

Remove silence from an action

1
2
3
4
http \
  POST \
  https://api.example.com/api/user-actions/a1b2c3d4-e5f6-7890-abcd-ef1234567890/unsilence/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.user_actions import user_actions_unsilence # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = user_actions_unsilence.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: user_actions_unsilence
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { userActionsUnsilence } from 'waldur-js-client';

try {
  const response = await userActionsUnsilence({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
status string

Booking

Marketplace Bookings

Operations Summary

Method Endpoint Description
GET /api/marketplace-bookings/{uuid}/ Retrieve

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-bookings/string-value/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_bookings import marketplace_bookings_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_bookings_list.sync(
    uuid="string-value",
    client=client
)

for item in response:
    print(item)
  1. API Source: marketplace_bookings_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceBookingsList } from 'waldur-js-client';

try {
  const response = await marketplaceBookingsList({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string ✓

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
created_by_full_name string
start string (date-time)
end string (date-time)

Booking Offerings

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/booking-offerings/ List Booking Offerings
GET /api/booking-offerings/{uuid}/ Retrieve
Other Actions
POST /api/booking-offerings/{uuid}/google_calendar_sync/ Google calendar sync
POST /api/booking-offerings/{uuid}/share_google_calendar/ Share google calendar
POST /api/booking-offerings/{uuid}/unshare_google_calendar/ Unshare google calendar

Core CRUD

List Booking Offerings

1
2
3
4
http \
  GET \
  https://api.example.com/api/booking-offerings/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.offering_field_enum import OfferingFieldEnum # (1)
from waldur_api_client.api.booking_offerings import booking_offerings_list # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = booking_offerings_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: OfferingFieldEnum
  2. API Source: booking_offerings_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { bookingOfferingsList } from 'waldur-js-client';

try {
  const response = await bookingOfferingsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
field array
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
created string (date-time)
name string
slug string URL-friendly identifier. Only editable by staff users.
description string
full_description string
privacy_policy_link string (uri)
access_url string (uri) Publicly accessible offering access URL
endpoints array of objects
endpoints.uuid string (uuid)
endpoints.name string
endpoints.url string URL of the access endpoint
software_catalogs array of objects
software_catalogs.uuid string (uuid)
software_catalogs.catalog any
software_catalogs.enabled_cpu_family any List of enabled CPU families: ['x86_64', 'aarch64']
software_catalogs.enabled_cpu_microarchitectures any List of enabled CPU microarchitectures: ['generic', 'zen3']
software_catalogs.package_count integer
software_catalogs.partition any
partitions array of objects
partitions.uuid string (uuid)
partitions.partition_name string Name of the SLURM partition
partitions.cpu_bind integer Default task binding policy (SLURM cpu_bind)
partitions.def_cpu_per_gpu integer Default CPUs allocated per GPU
partitions.max_cpus_per_node integer Maximum allocated CPUs per node
partitions.max_cpus_per_socket integer Maximum allocated CPUs per socket
partitions.def_mem_per_cpu integer (int64) Default memory per CPU in MB
partitions.def_mem_per_gpu integer (int64) Default memory per GPU in MB
partitions.def_mem_per_node integer (int64) Default memory per node in MB
partitions.max_mem_per_cpu integer (int64) Maximum memory per CPU in MB
partitions.max_mem_per_node integer (int64) Maximum memory per node in MB
partitions.default_time integer Default time limit in minutes
partitions.max_time integer Maximum time limit in minutes
partitions.grace_time integer Preemption grace time in seconds
partitions.max_nodes integer Maximum nodes per job
partitions.min_nodes integer Minimum nodes per job
partitions.exclusive_topo boolean Exclusive topology access required
partitions.exclusive_user boolean Exclusive user access required
partitions.priority_tier integer Priority tier for scheduling and preemption
partitions.qos string Quality of Service (QOS) name
partitions.req_resv boolean Require reservation for job allocation
roles array of objects
roles.uuid string (uuid)
roles.name string
roles.url string (uri)
customer string (uri)
customer_uuid string (uuid)
customer_name string
project string (uri)
project_uuid string (uuid)
project_name string
category string (uri)
category_uuid string (uuid)
category_title string
attributes object (free-form)
options any
resource_options any
components array of objects
components.uuid string (uuid)
components.billing_type string
Enum: fixed, usage, limit, one, few
components.type string Unique internal name of the measured unit, for example floating_ip.
components.name string Display name for the measured unit, for example, Floating IP.
components.description string
components.measured_unit string Unit of measurement, for example, GB.
components.unit_factor integer The conversion factor from backend units to measured_unit
components.limit_period any
components.limit_amount integer
components.article_code string
components.max_value integer
components.min_value integer
components.max_available_limit integer
components.is_boolean boolean
components.default_limit integer
components.factor integer
components.is_builtin boolean
components.is_prepaid boolean
components.overage_component string (uuid)
components.min_prepaid_duration integer
components.max_prepaid_duration integer
plugin_options any
state any
vendor_details string
getting_started string
integration_guide string
thumbnail string (uri)
order_count integer
plans array of objects
plans.url string (uri)
plans.uuid string (uuid)
plans.name string
plans.description string
plans.article_code string
plans.max_amount integer Maximum number of plans that could be active. Plan is disabled when maximum amount is reached.
plans.archived boolean Forbids creation of new resources.
plans.is_active boolean
plans.unit_price string (decimal)
plans.unit string
Enum: month, quarter, half_month, day, hour, quantity
plans.init_price number (double)
plans.switch_price number (double)
plans.backend_id string
plans.organization_groups array of objects
plans.organization_groups.uuid string (uuid)
plans.organization_groups.url string (uri)
plans.organization_groups.name string
plans.organization_groups.parent_uuid string (uuid) UUID of the parent organization group
plans.organization_groups.parent_name string Name of the parent organization group
plans.organization_groups.parent string (uri)
plans.organization_groups.customers_count integer Number of customers in this organization group
plans.components array of objects
plans.components.type string Unique internal name of the measured unit, for example floating_ip.
plans.components.name string Display name for the measured unit, for example, Floating IP.
plans.components.measured_unit string Unit of measurement, for example, GB.
plans.components.amount integer
plans.components.price string (decimal)
plans.components.future_price string (decimal)
plans.components.discount_threshold integer Minimum amount to be eligible for discount.
plans.components.discount_rate integer Discount rate in percentage.
plans.prices object (free-form)
plans.future_prices object (free-form)
plans.quotas object (free-form)
plans.resources_count integer
plans.plan_type string
plans.minimal_price number (double)
screenshots array of objects
screenshots.name string
screenshots.uuid string (uuid)
screenshots.description string
screenshots.image string (uri)
screenshots.thumbnail string (uri)
screenshots.created string (date-time)
type string
shared boolean Accessible to all customers.
billable boolean Purchase and usage is invoiced.
scope string
scope_uuid string (uuid)
scope_name string (uuid)
scope_state any
scope_error_message string
files array of objects
files.name string
files.created string (date-time)
files.file string (uri)
quotas array of objects
quotas.name string
quotas.usage integer
quotas.limit integer
paused_reason string
datacite_doi string
citation_count integer Number of citations of a DOI
latitude number (double)
longitude number (double)
country any Country code (ISO 3166-1 alpha-2)
backend_id string
organization_groups array of objects
organization_groups.uuid string (uuid)
organization_groups.url string (uri)
organization_groups.name string
organization_groups.parent_uuid string (uuid) UUID of the parent organization group
organization_groups.parent_name string Name of the parent organization group
organization_groups.parent string (uri)
organization_groups.customers_count integer Number of customers in this organization group
tags array of objects
tags.uuid string (uuid)
tags.name string
image string (uri)
total_customers integer
total_cost integer
total_cost_estimated integer
parent_description string
parent_uuid string (uuid)
parent_name string
backend_metadata any
has_compliance_requirements boolean
billing_type_classification string Classify offering components by billing type. Returns 'limit_only', 'usage_only', or 'mixed'.
compliance_checklist string (uri)
user_has_consent boolean
is_accessible boolean
googlecalendar object
googlecalendar.backend_id string
googlecalendar.public boolean
googlecalendar.http_link string

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/booking-offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.offering_field_enum import OfferingFieldEnum # (1)
from waldur_api_client.api.booking_offerings import booking_offerings_retrieve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = booking_offerings_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. Model Source: OfferingFieldEnum
  2. API Source: booking_offerings_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { bookingOfferingsRetrieve } from 'waldur-js-client';

try {
  const response = await bookingOfferingsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type
field array

200 -

Field Type Description
url string (uri)
uuid string (uuid)
created string (date-time)
name string
slug string URL-friendly identifier. Only editable by staff users.
description string
full_description string
privacy_policy_link string (uri)
access_url string (uri) Publicly accessible offering access URL
endpoints array of objects
endpoints.uuid string (uuid)
endpoints.name string
endpoints.url string URL of the access endpoint
software_catalogs array of objects
software_catalogs.uuid string (uuid)
software_catalogs.catalog any
software_catalogs.enabled_cpu_family any List of enabled CPU families: ['x86_64', 'aarch64']
software_catalogs.enabled_cpu_microarchitectures any List of enabled CPU microarchitectures: ['generic', 'zen3']
software_catalogs.package_count integer
software_catalogs.partition any
partitions array of objects
partitions.uuid string (uuid)
partitions.partition_name string Name of the SLURM partition
partitions.cpu_bind integer Default task binding policy (SLURM cpu_bind)
partitions.def_cpu_per_gpu integer Default CPUs allocated per GPU
partitions.max_cpus_per_node integer Maximum allocated CPUs per node
partitions.max_cpus_per_socket integer Maximum allocated CPUs per socket
partitions.def_mem_per_cpu integer (int64) Default memory per CPU in MB
partitions.def_mem_per_gpu integer (int64) Default memory per GPU in MB
partitions.def_mem_per_node integer (int64) Default memory per node in MB
partitions.max_mem_per_cpu integer (int64) Maximum memory per CPU in MB
partitions.max_mem_per_node integer (int64) Maximum memory per node in MB
partitions.default_time integer Default time limit in minutes
partitions.max_time integer Maximum time limit in minutes
partitions.grace_time integer Preemption grace time in seconds
partitions.max_nodes integer Maximum nodes per job
partitions.min_nodes integer Minimum nodes per job
partitions.exclusive_topo boolean Exclusive topology access required
partitions.exclusive_user boolean Exclusive user access required
partitions.priority_tier integer Priority tier for scheduling and preemption
partitions.qos string Quality of Service (QOS) name
partitions.req_resv boolean Require reservation for job allocation
roles array of objects
roles.uuid string (uuid)
roles.name string
roles.url string (uri)
customer string (uri)
customer_uuid string (uuid)
customer_name string
project string (uri)
project_uuid string (uuid)
project_name string
category string (uri)
category_uuid string (uuid)
category_title string
attributes object (free-form)
options any
resource_options any
components array of objects
components.uuid string (uuid)
components.billing_type string
Enum: fixed, usage, limit, one, few
components.type string Unique internal name of the measured unit, for example floating_ip.
components.name string Display name for the measured unit, for example, Floating IP.
components.description string
components.measured_unit string Unit of measurement, for example, GB.
components.unit_factor integer The conversion factor from backend units to measured_unit
components.limit_period any
components.limit_amount integer
components.article_code string
components.max_value integer
components.min_value integer
components.max_available_limit integer
components.is_boolean boolean
components.default_limit integer
components.factor integer
components.is_builtin boolean
components.is_prepaid boolean
components.overage_component string (uuid)
components.min_prepaid_duration integer
components.max_prepaid_duration integer
plugin_options any
state any
vendor_details string
getting_started string
integration_guide string
thumbnail string (uri)
order_count integer
plans array of objects
plans.url string (uri)
plans.uuid string (uuid)
plans.name string
plans.description string
plans.article_code string
plans.max_amount integer Maximum number of plans that could be active. Plan is disabled when maximum amount is reached.
plans.archived boolean Forbids creation of new resources.
plans.is_active boolean
plans.unit_price string (decimal)
plans.unit string
Enum: month, quarter, half_month, day, hour, quantity
plans.init_price number (double)
plans.switch_price number (double)
plans.backend_id string
plans.organization_groups array of objects
plans.organization_groups.uuid string (uuid)
plans.organization_groups.url string (uri)
plans.organization_groups.name string
plans.organization_groups.parent_uuid string (uuid) UUID of the parent organization group
plans.organization_groups.parent_name string Name of the parent organization group
plans.organization_groups.parent string (uri)
plans.organization_groups.customers_count integer Number of customers in this organization group
plans.components array of objects
plans.components.type string Unique internal name of the measured unit, for example floating_ip.
plans.components.name string Display name for the measured unit, for example, Floating IP.
plans.components.measured_unit string Unit of measurement, for example, GB.
plans.components.amount integer
plans.components.price string (decimal)
plans.components.future_price string (decimal)
plans.components.discount_threshold integer Minimum amount to be eligible for discount.
plans.components.discount_rate integer Discount rate in percentage.
plans.prices object (free-form)
plans.future_prices object (free-form)
plans.quotas object (free-form)
plans.resources_count integer
plans.plan_type string
plans.minimal_price number (double)
screenshots array of objects
screenshots.name string
screenshots.uuid string (uuid)
screenshots.description string
screenshots.image string (uri)
screenshots.thumbnail string (uri)
screenshots.created string (date-time)
type string
shared boolean Accessible to all customers.
billable boolean Purchase and usage is invoiced.
scope string
scope_uuid string (uuid)
scope_name string (uuid)
scope_state any
scope_error_message string
files array of objects
files.name string
files.created string (date-time)
files.file string (uri)
quotas array of objects
quotas.name string
quotas.usage integer
quotas.limit integer
paused_reason string
datacite_doi string
citation_count integer Number of citations of a DOI
latitude number (double)
longitude number (double)
country any Country code (ISO 3166-1 alpha-2)
backend_id string
organization_groups array of objects
organization_groups.uuid string (uuid)
organization_groups.url string (uri)
organization_groups.name string
organization_groups.parent_uuid string (uuid) UUID of the parent organization group
organization_groups.parent_name string Name of the parent organization group
organization_groups.parent string (uri)
organization_groups.customers_count integer Number of customers in this organization group
tags array of objects
tags.uuid string (uuid)
tags.name string
image string (uri)
total_customers integer
total_cost integer
total_cost_estimated integer
parent_description string
parent_uuid string (uuid)
parent_name string
backend_metadata any
has_compliance_requirements boolean
billing_type_classification string Classify offering components by billing type. Returns 'limit_only', 'usage_only', or 'mixed'.
compliance_checklist string (uri)
user_has_consent boolean
is_accessible boolean
googlecalendar object
googlecalendar.backend_id string
googlecalendar.public boolean
googlecalendar.http_link string

Other Actions

Google calendar sync

1
2
3
4
http \
  POST \
  https://api.example.com/api/booking-offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/google_calendar_sync/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.booking_offerings import booking_offerings_google_calendar_sync # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = booking_offerings_google_calendar_sync.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: booking_offerings_google_calendar_sync
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { bookingOfferingsGoogleCalendarSync } from 'waldur-js-client';

try {
  const response = await bookingOfferingsGoogleCalendarSync({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 - No response body

Share google calendar

1
2
3
4
http \
  POST \
  https://api.example.com/api/booking-offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/share_google_calendar/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.booking_offerings import booking_offerings_share_google_calendar # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = booking_offerings_share_google_calendar.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: booking_offerings_share_google_calendar
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { bookingOfferingsShareGoogleCalendar } from 'waldur-js-client';

try {
  const response = await bookingOfferingsShareGoogleCalendar({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 - No response body

Unshare google calendar

1
2
3
4
http \
  POST \
  https://api.example.com/api/booking-offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/unshare_google_calendar/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.booking_offerings import booking_offerings_unshare_google_calendar # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = booking_offerings_unshare_google_calendar.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: booking_offerings_unshare_google_calendar
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { bookingOfferingsUnshareGoogleCalendar } from 'waldur-js-client';

try {
  const response = await bookingOfferingsUnshareGoogleCalendar({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 - No response body

Booking Resources

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/booking-resources/ List Booking Resources
GET /api/booking-resources/{uuid}/ Retrieve
Other Actions
POST /api/booking-resources/{uuid}/accept/ Accept
POST /api/booking-resources/{uuid}/reject/ Reject

Core CRUD

List Booking Resources

1
2
3
4
http \
  GET \
  https://api.example.com/api/booking-resources/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.booking_resource_field_enum import BookingResourceFieldEnum # (1)
from waldur_api_client.models.booking_resource_o_enum import BookingResourceOEnum # (2)
from waldur_api_client.models.order_state import OrderState # (3)
from waldur_api_client.models.resource_state import ResourceState # (4)
from waldur_api_client.api.booking_resources import booking_resources_list # (5)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = booking_resources_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: BookingResourceFieldEnum
  2. Model Source: BookingResourceOEnum
  3. Model Source: OrderState
  4. Model Source: ResourceState
  5. API Source: booking_resources_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { bookingResourcesList } from 'waldur-js-client';

try {
  const response = await bookingResourcesList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
backend_id string Backend ID
category_uuid string (uuid) Category UUID
component_count number Filter by exact number of components
connected_customer_uuid string (uuid)
created string (date-time) Created after
customer string (uri) Customer URL
customer_uuid string (uuid) Customer UUID
downscaled boolean Downscaled
field array
has_terminate_date boolean Has termination date
is_attached boolean Filter by attached state
lexis_links_supported boolean LEXIS links supported
limit_based boolean Filter by limit-based offerings
limit_component_count number Filter by exact number of limit-based components
modified string (date-time) Modified after
name string Name
name_exact string Name (exact)
o array Ordering
offering string (uri)
offering_billable boolean Offering billable
offering_shared boolean Offering shared
offering_slug array Multiple values may be separated by commas.
offering_type string Offering type
offering_uuid array Multiple values may be separated by commas.
only_limit_based boolean Filter resources with only limit-based components
only_usage_based boolean Filter resources with only usage-based components
order_state array Order state
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
parent_offering_uuid string (uuid)
paused boolean Paused
plan_uuid string (uuid) Plan UUID
project_name string Project name
project_uuid string (uuid) Project UUID
provider_uuid string (uuid) Provider UUID
query string Search by resource UUID, name, slug, backend ID, effective ID, IPs or hypervisor
restrict_member_access boolean Restrict member access
runtime_state string Runtime state
service_manager_uuid string (uuid) Service manager UUID
state array Resource state
usage_based boolean Filter by usage-based offerings
visible_to_providers boolean Include only resources visible to service providers
visible_to_username string Visible to username

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
offering string (uri)
offering_name string
offering_uuid string (uuid)
offering_description string
offering_image string (uri)
offering_thumbnail string (uri)
offering_type string
offering_shared boolean Accessible to all customers.
offering_billable boolean Purchase and usage is invoiced.
offering_plugin_options any Public data used by specific plugin, such as storage mode for OpenStack.
provider_name string
provider_uuid string (uuid)
provider_slug string
category_title string
category_uuid string (uuid)
category_icon string (uri)
plan string (uri)
plan_unit any
plan_name string
plan_uuid string (uuid)
plan_description string
attributes object (free-form)
limits object (free-form)
uuid string (uuid)
created string (date-time)
modified string (date-time)
url string (uri)
scope string
description string
state any
resource_uuid string (uuid)
backend_id string
effective_id string
resource_type string
project string (uri)
project_uuid string (uuid)
project_name string
project_description string
project_end_date string (date) The date is inclusive. Once reached, all project resource will be scheduled for termination.
project_end_date_requested_by string (uri)
customer_uuid string (uuid)
customer_name string
offering_slug string
parent_offering_uuid string (uuid)
parent_offering_name string
parent_offering_slug string
offering_backend_id string
parent_uuid string (uuid)
parent_name string
backend_metadata any
is_usage_based boolean Returns True if the resource has usage-based components that track variable consumption.
is_limit_based boolean Returns True if the resource has limit-based components with user-adjustable quotas.
name string
slug string URL-friendly identifier. Only editable by staff users.
current_usages object (free-form) Dictionary mapping component types to their latest reported usage amounts.
can_terminate boolean
report array of objects
report.header string Section header text
report.body string Section body content
end_date string (date) The date is inclusive. Once reached, a resource will be scheduled for termination.
end_date_requested_by string (uri)
username string
limit_usage object (free-form) Dictionary mapping limit-based component types to their consumed usage. For monthly periods, maps from current_usages; for longer periods, aggregates historical usage.
downscaled boolean
restrict_member_access boolean
paused boolean
endpoints array of objects
endpoints.uuid string (uuid)
endpoints.name string
endpoints.url string URL of the access endpoint
error_message string
error_traceback string
options any
available_actions array of strings
last_sync string (date-time)
order_in_progress any
creation_order any
service_settings_uuid string (uuid)
project_slug string
customer_slug string
user_requires_reconsent boolean Check if the current user needs to re-consent for this resource's offering.
renewal_date object (free-form)
offering_state any
offering_components array of objects
offering_components.uuid string (uuid)
offering_components.billing_type string
Enum: fixed, usage, limit, one, few
offering_components.type string Unique internal name of the measured unit, for example floating_ip.
offering_components.name string Display name for the measured unit, for example, Floating IP.
offering_components.description string
offering_components.measured_unit string Unit of measurement, for example, GB.
offering_components.unit_factor integer The conversion factor from backend units to measured_unit
offering_components.limit_period any
offering_components.limit_amount integer
offering_components.article_code string
offering_components.max_value integer
offering_components.min_value integer
offering_components.max_available_limit integer
offering_components.is_boolean boolean
offering_components.default_limit integer
offering_components.factor integer
offering_components.is_builtin boolean
offering_components.is_prepaid boolean
offering_components.overage_component string (uuid)
offering_components.min_prepaid_duration integer
offering_components.max_prepaid_duration integer
created_by string (uri)
created_by_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
created_by_full_name string
consumer_reviewed_by string (uri)
consumer_reviewed_by_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
consumer_reviewed_by_full_name string
slots array of objects
slots.start string (date-time)
slots.end string (date-time)
slots.backend_id string

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/booking-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.booking_resource_field_enum import BookingResourceFieldEnum # (1)
from waldur_api_client.api.booking_resources import booking_resources_retrieve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = booking_resources_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. Model Source: BookingResourceFieldEnum
  2. API Source: booking_resources_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { bookingResourcesRetrieve } from 'waldur-js-client';

try {
  const response = await bookingResourcesRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type
field array

200 -

Field Type Description
offering string (uri)
offering_name string
offering_uuid string (uuid)
offering_description string
offering_image string (uri)
offering_thumbnail string (uri)
offering_type string
offering_shared boolean Accessible to all customers.
offering_billable boolean Purchase and usage is invoiced.
offering_plugin_options any Public data used by specific plugin, such as storage mode for OpenStack.
provider_name string
provider_uuid string (uuid)
provider_slug string
category_title string
category_uuid string (uuid)
category_icon string (uri)
plan string (uri)
plan_unit any
plan_name string
plan_uuid string (uuid)
plan_description string
attributes object (free-form)
limits object (free-form)
uuid string (uuid)
created string (date-time)
modified string (date-time)
url string (uri)
scope string
description string
state any
resource_uuid string (uuid)
backend_id string
effective_id string
resource_type string
project string (uri)
project_uuid string (uuid)
project_name string
project_description string
project_end_date string (date) The date is inclusive. Once reached, all project resource will be scheduled for termination.
project_end_date_requested_by string (uri)
customer_uuid string (uuid)
customer_name string
offering_slug string
parent_offering_uuid string (uuid)
parent_offering_name string
parent_offering_slug string
offering_backend_id string
parent_uuid string (uuid)
parent_name string
backend_metadata any
is_usage_based boolean Returns True if the resource has usage-based components that track variable consumption.
is_limit_based boolean Returns True if the resource has limit-based components with user-adjustable quotas.
name string
slug string URL-friendly identifier. Only editable by staff users.
current_usages object (free-form) Dictionary mapping component types to their latest reported usage amounts.
can_terminate boolean
report array of objects
report.header string Section header text
report.body string Section body content
end_date string (date) The date is inclusive. Once reached, a resource will be scheduled for termination.
end_date_requested_by string (uri)
username string
limit_usage object (free-form) Dictionary mapping limit-based component types to their consumed usage. For monthly periods, maps from current_usages; for longer periods, aggregates historical usage.
downscaled boolean
restrict_member_access boolean
paused boolean
endpoints array of objects
endpoints.uuid string (uuid)
endpoints.name string
endpoints.url string URL of the access endpoint
error_message string
error_traceback string
options any
available_actions array of strings
last_sync string (date-time)
order_in_progress any
creation_order any
service_settings_uuid string (uuid)
project_slug string
customer_slug string
user_requires_reconsent boolean Check if the current user needs to re-consent for this resource's offering.
renewal_date object (free-form)
offering_state any
offering_components array of objects
offering_components.uuid string (uuid)
offering_components.billing_type string
Enum: fixed, usage, limit, one, few
offering_components.type string Unique internal name of the measured unit, for example floating_ip.
offering_components.name string Display name for the measured unit, for example, Floating IP.
offering_components.description string
offering_components.measured_unit string Unit of measurement, for example, GB.
offering_components.unit_factor integer The conversion factor from backend units to measured_unit
offering_components.limit_period any
offering_components.limit_amount integer
offering_components.article_code string
offering_components.max_value integer
offering_components.min_value integer
offering_components.max_available_limit integer
offering_components.is_boolean boolean
offering_components.default_limit integer
offering_components.factor integer
offering_components.is_builtin boolean
offering_components.is_prepaid boolean
offering_components.overage_component string (uuid)
offering_components.min_prepaid_duration integer
offering_components.max_prepaid_duration integer
created_by string (uri)
created_by_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
created_by_full_name string
consumer_reviewed_by string (uri)
consumer_reviewed_by_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
consumer_reviewed_by_full_name string
slots array of objects
slots.start string (date-time)
slots.end string (date-time)
slots.backend_id string

Other Actions

Accept

1
2
3
4
http \
  POST \
  https://api.example.com/api/booking-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/accept/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.booking_resources import booking_resources_accept # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = booking_resources_accept.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: booking_resources_accept
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { bookingResourcesAccept } from 'waldur-js-client';

try {
  const response = await bookingResourcesAccept({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 - No response body

Reject

1
2
3
4
http \
  POST \
  https://api.example.com/api/booking-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/reject/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.booking_resources import booking_resources_reject # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = booking_resources_reject.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: booking_resources_reject
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { bookingResourcesReject } from 'waldur-js-client';

try {
  const response = await bookingResourcesReject({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 - No response body

Categories

Marketplace Categories

Operations Summary

Method Endpoint Description
GET /api/marketplace-categories/ List categories
GET /api/marketplace-categories/{uuid}/ Retrieve a category
POST /api/marketplace-categories/ Create a category
PUT /api/marketplace-categories/{uuid}/ Update a category
PATCH /api/marketplace-categories/{uuid}/ Partially update a category
DELETE /api/marketplace-categories/{uuid}/ Delete a category

List categories

Returns a paginated list of marketplace categories.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-categories/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.maintenance_type_enum import MaintenanceTypeEnum # (1)
from waldur_api_client.models.marketplace_category_field_enum import MarketplaceCategoryFieldEnum # (2)
from waldur_api_client.api.marketplace_categories import marketplace_categories_list # (3)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_categories_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: MaintenanceTypeEnum
  2. Model Source: MarketplaceCategoryFieldEnum
  3. API Source: marketplace_categories_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceCategoriesList } from 'waldur-js-client';

try {
  const response = await marketplaceCategoriesList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
customer_uuid string (uuid) Customer UUID
customers_offerings_state array Customers offerings state
field array
group_uuid string (uuid) Category group UUID
has_shared boolean Has shared
offering_name string Offering name contains
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
resource_customer_uuid string (uuid) Resource customer UUID
resource_project_uuid string (uuid) Resource project UUID
title string Title contains

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
title string
description string
icon string (uri)
default_vm_category boolean Set to "true" if this category is for OpenStack VM. Only one category can have "true" value.
default_volume_category boolean Set to true if this category is for OpenStack Volume. Only one category can have "true" value.
default_tenant_category boolean Set to true if this category is for OpenStack Tenant. Only one category can have "true" value.
offering_count integer
available_offerings_count integer
sections array of objects
sections.key string
sections.title string
sections.attributes array of objects
sections.attributes.key string
sections.attributes.title string
sections.attributes.type string
Enum: boolean, string, text, integer, choice, list
sections.attributes.options array of objects
sections.attributes.options.key string
sections.attributes.options.title string
sections.attributes.required boolean A value must be provided for the attribute.
sections.attributes.default any
sections.is_standalone boolean Whether section is rendered as a separate tab.
columns array of objects
columns.uuid string (uuid)
columns.index integer Index allows to reorder columns.
columns.title string Title is rendered as column header.
columns.attribute string Resource attribute is rendered as table cell.
columns.widget any Widget field allows to customise table cell rendering.
components array of objects
components.type string Unique internal name of the measured unit, for example floating_ip.
components.name string Display name for the measured unit, for example, Floating IP.
components.description string
components.measured_unit string Unit of measurement, for example, GB.
articles array of objects
articles.title string
articles.url string (uri)
group string (uri)

Retrieve a category

Returns details of a specific marketplace category.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-categories/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.marketplace_category_field_enum import MarketplaceCategoryFieldEnum # (1)
from waldur_api_client.api.marketplace_categories import marketplace_categories_retrieve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_categories_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. Model Source: MarketplaceCategoryFieldEnum
  2. API Source: marketplace_categories_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceCategoriesRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceCategoriesRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type
field array

200 -

Field Type Description
url string (uri)
uuid string (uuid)
title string
description string
icon string (uri)
default_vm_category boolean Set to "true" if this category is for OpenStack VM. Only one category can have "true" value.
default_volume_category boolean Set to true if this category is for OpenStack Volume. Only one category can have "true" value.
default_tenant_category boolean Set to true if this category is for OpenStack Tenant. Only one category can have "true" value.
offering_count integer
available_offerings_count integer
sections array of objects
sections.key string
sections.title string
sections.attributes array of objects
sections.attributes.key string
sections.attributes.title string
sections.attributes.type string
Enum: boolean, string, text, integer, choice, list
sections.attributes.options array of objects
sections.attributes.options.key string
sections.attributes.options.title string
sections.attributes.required boolean A value must be provided for the attribute.
sections.attributes.default any
sections.is_standalone boolean Whether section is rendered as a separate tab.
columns array of objects
columns.uuid string (uuid)
columns.index integer Index allows to reorder columns.
columns.title string Title is rendered as column header.
columns.attribute string Resource attribute is rendered as table cell.
columns.widget any Widget field allows to customise table cell rendering.
components array of objects
components.type string Unique internal name of the measured unit, for example floating_ip.
components.name string Display name for the measured unit, for example, Floating IP.
components.description string
components.measured_unit string Unit of measurement, for example, GB.
articles array of objects
articles.title string
articles.url string (uri)
group string (uri)

Create a category

Creates a new marketplace category. Requires staff permissions.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/marketplace-categories/ \
  Authorization:"Token YOUR_API_TOKEN" \
  title="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.marketplace_category_request import MarketplaceCategoryRequest # (1)
from waldur_api_client.api.marketplace_categories import marketplace_categories_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = MarketplaceCategoryRequest(
    title="string-value"
)
response = marketplace_categories_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: MarketplaceCategoryRequest
  2. API Source: marketplace_categories_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceCategoriesCreate } from 'waldur-js-client';

try {
  const response = await marketplaceCategoriesCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "title": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
title string ✓
description string
icon string (binary)
default_vm_category boolean Set to "true" if this category is for OpenStack VM. Only one category can have "true" value.
default_volume_category boolean Set to true if this category is for OpenStack Volume. Only one category can have "true" value.
default_tenant_category boolean Set to true if this category is for OpenStack Tenant. Only one category can have "true" value.
group string (uri)

201 -

Field Type Description
url string (uri)
uuid string (uuid)
title string
description string
icon string (uri)
default_vm_category boolean Set to "true" if this category is for OpenStack VM. Only one category can have "true" value.
default_volume_category boolean Set to true if this category is for OpenStack Volume. Only one category can have "true" value.
default_tenant_category boolean Set to true if this category is for OpenStack Tenant. Only one category can have "true" value.
offering_count integer
available_offerings_count integer
sections array of objects
sections.key string
sections.title string
sections.attributes array of objects
sections.attributes.key string
sections.attributes.title string
sections.attributes.type string
Enum: boolean, string, text, integer, choice, list
sections.attributes.options array of objects
sections.attributes.options.key string
sections.attributes.options.title string
sections.attributes.required boolean A value must be provided for the attribute.
sections.attributes.default any
sections.is_standalone boolean Whether section is rendered as a separate tab.
columns array of objects
columns.uuid string (uuid)
columns.index integer Index allows to reorder columns.
columns.title string Title is rendered as column header.
columns.attribute string Resource attribute is rendered as table cell.
columns.widget any Widget field allows to customise table cell rendering.
components array of objects
components.type string Unique internal name of the measured unit, for example floating_ip.
components.name string Display name for the measured unit, for example, Floating IP.
components.description string
components.measured_unit string Unit of measurement, for example, GB.
articles array of objects
articles.title string
articles.url string (uri)
group string (uri)

Update a category

Updates an existing marketplace category. Requires staff permissions.

1
2
3
4
5
http \
  PUT \
  https://api.example.com/api/marketplace-categories/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  title="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.marketplace_category_request import MarketplaceCategoryRequest # (1)
from waldur_api_client.api.marketplace_categories import marketplace_categories_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = MarketplaceCategoryRequest(
    title="string-value"
)
response = marketplace_categories_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: MarketplaceCategoryRequest
  2. API Source: marketplace_categories_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { marketplaceCategoriesUpdate } from 'waldur-js-client';

try {
  const response = await marketplaceCategoriesUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "title": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
title string ✓
description string
icon string (binary)
default_vm_category boolean Set to "true" if this category is for OpenStack VM. Only one category can have "true" value.
default_volume_category boolean Set to true if this category is for OpenStack Volume. Only one category can have "true" value.
default_tenant_category boolean Set to true if this category is for OpenStack Tenant. Only one category can have "true" value.
group string (uri)

200 -

Field Type Description
url string (uri)
uuid string (uuid)
title string
description string
icon string (uri)
default_vm_category boolean Set to "true" if this category is for OpenStack VM. Only one category can have "true" value.
default_volume_category boolean Set to true if this category is for OpenStack Volume. Only one category can have "true" value.
default_tenant_category boolean Set to true if this category is for OpenStack Tenant. Only one category can have "true" value.
offering_count integer
available_offerings_count integer
sections array of objects
sections.key string
sections.title string
sections.attributes array of objects
sections.attributes.key string
sections.attributes.title string
sections.attributes.type string
Enum: boolean, string, text, integer, choice, list
sections.attributes.options array of objects
sections.attributes.options.key string
sections.attributes.options.title string
sections.attributes.required boolean A value must be provided for the attribute.
sections.attributes.default any
sections.is_standalone boolean Whether section is rendered as a separate tab.
columns array of objects
columns.uuid string (uuid)
columns.index integer Index allows to reorder columns.
columns.title string Title is rendered as column header.
columns.attribute string Resource attribute is rendered as table cell.
columns.widget any Widget field allows to customise table cell rendering.
components array of objects
components.type string Unique internal name of the measured unit, for example floating_ip.
components.name string Display name for the measured unit, for example, Floating IP.
components.description string
components.measured_unit string Unit of measurement, for example, GB.
articles array of objects
articles.title string
articles.url string (uri)
group string (uri)

Partially update a category

Partially updates an existing marketplace category. Requires staff permissions.

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/marketplace-categories/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_marketplace_category_request import PatchedMarketplaceCategoryRequest # (1)
from waldur_api_client.api.marketplace_categories import marketplace_categories_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedMarketplaceCategoryRequest()
response = marketplace_categories_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedMarketplaceCategoryRequest
  2. API Source: marketplace_categories_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceCategoriesPartialUpdate } from 'waldur-js-client';

try {
  const response = await marketplaceCategoriesPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
title string
description string
icon string (binary)
default_vm_category boolean Set to "true" if this category is for OpenStack VM. Only one category can have "true" value.
default_volume_category boolean Set to true if this category is for OpenStack Volume. Only one category can have "true" value.
default_tenant_category boolean Set to true if this category is for OpenStack Tenant. Only one category can have "true" value.
group string (uri)

200 -

Field Type Description
url string (uri)
uuid string (uuid)
title string
description string
icon string (uri)
default_vm_category boolean Set to "true" if this category is for OpenStack VM. Only one category can have "true" value.
default_volume_category boolean Set to true if this category is for OpenStack Volume. Only one category can have "true" value.
default_tenant_category boolean Set to true if this category is for OpenStack Tenant. Only one category can have "true" value.
offering_count integer
available_offerings_count integer
sections array of objects
sections.key string
sections.title string
sections.attributes array of objects
sections.attributes.key string
sections.attributes.title string
sections.attributes.type string
Enum: boolean, string, text, integer, choice, list
sections.attributes.options array of objects
sections.attributes.options.key string
sections.attributes.options.title string
sections.attributes.required boolean A value must be provided for the attribute.
sections.attributes.default any
sections.is_standalone boolean Whether section is rendered as a separate tab.
columns array of objects
columns.uuid string (uuid)
columns.index integer Index allows to reorder columns.
columns.title string Title is rendered as column header.
columns.attribute string Resource attribute is rendered as table cell.
columns.widget any Widget field allows to customise table cell rendering.
components array of objects
components.type string Unique internal name of the measured unit, for example floating_ip.
components.name string Display name for the measured unit, for example, Floating IP.
components.description string
components.measured_unit string Unit of measurement, for example, GB.
articles array of objects
articles.title string
articles.url string (uri)
group string (uri)

Delete a category

Deletes a marketplace category. Requires staff permissions.

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/marketplace-categories/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_categories import marketplace_categories_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_categories_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_categories_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceCategoriesDestroy } from 'waldur-js-client';

try {
  const response = await marketplaceCategoriesDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Marketplace Category Columns

Operations Summary

Method Endpoint Description
GET /api/marketplace-category-columns/ List category columns
GET /api/marketplace-category-columns/{uuid}/ Retrieve a category column
POST /api/marketplace-category-columns/ Create a category column
PUT /api/marketplace-category-columns/{uuid}/ Update a category column
PATCH /api/marketplace-category-columns/{uuid}/ Partially update a category column
DELETE /api/marketplace-category-columns/{uuid}/ Delete a category column

List category columns

Returns a paginated list of category columns used for resource table rendering.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-category-columns/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_category_columns import marketplace_category_columns_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_category_columns_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: marketplace_category_columns_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceCategoryColumnsList } from 'waldur-js-client';

try {
  const response = await marketplaceCategoryColumnsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
category_uuid string (uuid) Category UUID
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
title string Title contains

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid)
index integer Index allows to reorder columns.
title string Title is rendered as column header.
attribute string Resource attribute is rendered as table cell.
widget any Widget field allows to customise table cell rendering.
category string (uri)

Retrieve a category column

Returns details of a specific category column.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-category-columns/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_category_columns import marketplace_category_columns_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_category_columns_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_category_columns_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceCategoryColumnsRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceCategoryColumnsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
uuid string (uuid)
index integer Index allows to reorder columns.
title string Title is rendered as column header.
attribute string Resource attribute is rendered as table cell.
widget any Widget field allows to customise table cell rendering.
category string (uri)

Create a category column

Creates a new category column. Requires staff permissions.

1
2
3
4
5
6
7
http \
  POST \
  https://api.example.com/api/marketplace-category-columns/ \
  Authorization:"Token YOUR_API_TOKEN" \
  index=123 \
  title="string-value" \
  category="https://api.example.com/api/category/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.category_column_request import CategoryColumnRequest # (1)
from waldur_api_client.api.marketplace_category_columns import marketplace_category_columns_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = CategoryColumnRequest(
    index=123,
    title="string-value",
    category="https://api.example.com/api/category/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = marketplace_category_columns_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: CategoryColumnRequest
  2. API Source: marketplace_category_columns_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
import { marketplaceCategoryColumnsCreate } from 'waldur-js-client';

try {
  const response = await marketplaceCategoryColumnsCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "index": 123,
    "title": "string-value",
    "category": "https://api.example.com/api/category/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
index integer ✓ Index allows to reorder columns.
title string ✓ Title is rendered as column header.
attribute string Resource attribute is rendered as table cell.
widget any Widget field allows to customise table cell rendering.
category string (uri) ✓

201 -

Field Type Description
uuid string (uuid)
index integer Index allows to reorder columns.
title string Title is rendered as column header.
attribute string Resource attribute is rendered as table cell.
widget any Widget field allows to customise table cell rendering.
category string (uri)

Update a category column

Updates an existing category column. Requires staff permissions.

1
2
3
4
5
6
7
http \
  PUT \
  https://api.example.com/api/marketplace-category-columns/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  index=123 \
  title="string-value" \
  category="https://api.example.com/api/category/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.category_column_request import CategoryColumnRequest # (1)
from waldur_api_client.api.marketplace_category_columns import marketplace_category_columns_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = CategoryColumnRequest(
    index=123,
    title="string-value",
    category="https://api.example.com/api/category/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = marketplace_category_columns_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: CategoryColumnRequest
  2. API Source: marketplace_category_columns_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
import { marketplaceCategoryColumnsUpdate } from 'waldur-js-client';

try {
  const response = await marketplaceCategoryColumnsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "index": 123,
    "title": "string-value",
    "category": "https://api.example.com/api/category/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
index integer ✓ Index allows to reorder columns.
title string ✓ Title is rendered as column header.
attribute string Resource attribute is rendered as table cell.
widget any Widget field allows to customise table cell rendering.
category string (uri) ✓

200 -

Field Type Description
uuid string (uuid)
index integer Index allows to reorder columns.
title string Title is rendered as column header.
attribute string Resource attribute is rendered as table cell.
widget any Widget field allows to customise table cell rendering.
category string (uri)

Partially update a category column

Partially updates an existing category column. Requires staff permissions.

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/marketplace-category-columns/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_category_column_request import PatchedCategoryColumnRequest # (1)
from waldur_api_client.api.marketplace_category_columns import marketplace_category_columns_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedCategoryColumnRequest()
response = marketplace_category_columns_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedCategoryColumnRequest
  2. API Source: marketplace_category_columns_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceCategoryColumnsPartialUpdate } from 'waldur-js-client';

try {
  const response = await marketplaceCategoryColumnsPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
index integer Index allows to reorder columns.
title string Title is rendered as column header.
attribute string Resource attribute is rendered as table cell.
widget any Widget field allows to customise table cell rendering.
category string (uri)

200 -

Field Type Description
uuid string (uuid)
index integer Index allows to reorder columns.
title string Title is rendered as column header.
attribute string Resource attribute is rendered as table cell.
widget any Widget field allows to customise table cell rendering.
category string (uri)

Delete a category column

Deletes a category column. Requires staff permissions.

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/marketplace-category-columns/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_category_columns import marketplace_category_columns_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_category_columns_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_category_columns_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceCategoryColumnsDestroy } from 'waldur-js-client';

try {
  const response = await marketplaceCategoryColumnsDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Marketplace Category Components

Operations Summary

Method Endpoint Description
GET /api/marketplace-category-components/ List category components
GET /api/marketplace-category-components/{id}/ Retrieve a category component
POST /api/marketplace-category-components/ Create a category component
PUT /api/marketplace-category-components/{id}/ Update a category component
PATCH /api/marketplace-category-components/{id}/ Partially update a category component
DELETE /api/marketplace-category-components/{id}/ Delete a category component

List category components

Returns a paginated list of all components defined at the category level. These act as templates for components in offerings.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-category-components/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_category_components import marketplace_category_components_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_category_components_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: marketplace_category_components_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceCategoryComponentsList } from 'waldur-js-client';

try {
  const response = await marketplaceCategoryComponentsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid)
type string Unique internal name of the measured unit, for example floating_ip.
name string Display name for the measured unit, for example, Floating IP.
description string
measured_unit string Unit of measurement, for example, GB.
category object
category.url string (uri)
category.uuid string (uuid)
category.title string

Retrieve a category component

Returns the details of a specific category component, identified by its ID.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-category-components/123/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_category_components import marketplace_category_components_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_category_components_retrieve.sync(
    id=123,
    client=client
)

print(response)
  1. API Source: marketplace_category_components_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceCategoryComponentsRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceCategoryComponentsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "id": 123
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
id integer ✓ A unique integer value identifying this category component.

200 -

Field Type Description
uuid string (uuid)
type string Unique internal name of the measured unit, for example floating_ip.
name string Display name for the measured unit, for example, Floating IP.
description string
measured_unit string Unit of measurement, for example, GB.
category object
category.url string (uri)
category.uuid string (uuid)
category.title string

Create a category component

Creates a new component for a category. Requires staff permissions.

1
2
3
4
5
6
7
http \
  POST \
  https://api.example.com/api/marketplace-category-components/ \
  Authorization:"Token YOUR_API_TOKEN" \
  type="string-value" \
  name="my-awesome-marketplace-category-component" \
  category:='{}'

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.category_components_request import CategoryComponentsRequest # (1)
from waldur_api_client.api.marketplace_category_components import marketplace_category_components_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = CategoryComponentsRequest(
    type="string-value",
    name="my-awesome-marketplace-category-component",
    category={}
)
response = marketplace_category_components_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: CategoryComponentsRequest
  2. API Source: marketplace_category_components_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
import { marketplaceCategoryComponentsCreate } from 'waldur-js-client';

try {
  const response = await marketplaceCategoryComponentsCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "type": "string-value",
    "name": "my-awesome-marketplace-category-component",
    "category": {}
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
type string ✓ Unique internal name of the measured unit, for example floating_ip.
name string ✓ Display name for the measured unit, for example, Floating IP.
description string
measured_unit string Unit of measurement, for example, GB.
category object ✓
category.title string ✓

201 -

Field Type Description
uuid string (uuid)
type string Unique internal name of the measured unit, for example floating_ip.
name string Display name for the measured unit, for example, Floating IP.
description string
measured_unit string Unit of measurement, for example, GB.
category object
category.url string (uri)
category.uuid string (uuid)
category.title string

Update a category component

Updates an existing category component. Requires staff permissions.

1
2
3
4
5
6
7
http \
  PUT \
  https://api.example.com/api/marketplace-category-components/123/ \
  Authorization:"Token YOUR_API_TOKEN" \
  type="string-value" \
  name="my-awesome-marketplace-category-component" \
  category:='{}'

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.category_components_request import CategoryComponentsRequest # (1)
from waldur_api_client.api.marketplace_category_components import marketplace_category_components_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = CategoryComponentsRequest(
    type="string-value",
    name="my-awesome-marketplace-category-component",
    category={}
)
response = marketplace_category_components_update.sync(
    id=123,
    client=client,
    body=body_data
)

print(response)
  1. Model Source: CategoryComponentsRequest
  2. API Source: marketplace_category_components_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
import { marketplaceCategoryComponentsUpdate } from 'waldur-js-client';

try {
  const response = await marketplaceCategoryComponentsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "id": 123
  },
  body: {
    "type": "string-value",
    "name": "my-awesome-marketplace-category-component",
    "category": {}
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
id integer ✓ A unique integer value identifying this category component.
Field Type Required Description
type string ✓ Unique internal name of the measured unit, for example floating_ip.
name string ✓ Display name for the measured unit, for example, Floating IP.
description string
measured_unit string Unit of measurement, for example, GB.
category object ✓
category.title string ✓

200 -

Field Type Description
uuid string (uuid)
type string Unique internal name of the measured unit, for example floating_ip.
name string Display name for the measured unit, for example, Floating IP.
description string
measured_unit string Unit of measurement, for example, GB.
category object
category.url string (uri)
category.uuid string (uuid)
category.title string

Partially update a category component

Partially updates an existing category component. Requires staff permissions.

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/marketplace-category-components/123/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_category_components_request import PatchedCategoryComponentsRequest # (1)
from waldur_api_client.api.marketplace_category_components import marketplace_category_components_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedCategoryComponentsRequest()
response = marketplace_category_components_partial_update.sync(
    id=123,
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedCategoryComponentsRequest
  2. API Source: marketplace_category_components_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceCategoryComponentsPartialUpdate } from 'waldur-js-client';

try {
  const response = await marketplaceCategoryComponentsPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "id": 123
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
id integer ✓ A unique integer value identifying this category component.
Field Type Required Description
type string Unique internal name of the measured unit, for example floating_ip.
name string Display name for the measured unit, for example, Floating IP.
description string
measured_unit string Unit of measurement, for example, GB.
category object
category.title string ✓

200 -

Field Type Description
uuid string (uuid)
type string Unique internal name of the measured unit, for example floating_ip.
name string Display name for the measured unit, for example, Floating IP.
description string
measured_unit string Unit of measurement, for example, GB.
category object
category.url string (uri)
category.uuid string (uuid)
category.title string

Delete a category component

Deletes a category component. Requires staff permissions.

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/marketplace-category-components/123/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_category_components import marketplace_category_components_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_category_components_destroy.sync(
    id=123,
    client=client
)

print(response)
  1. API Source: marketplace_category_components_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceCategoryComponentsDestroy } from 'waldur-js-client';

try {
  const response = await marketplaceCategoryComponentsDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "id": 123
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
id integer ✓ A unique integer value identifying this category component.

204 - No response body

Marketplace Category Groups

Operations Summary

Method Endpoint Description
GET /api/marketplace-category-groups/ List category groups
GET /api/marketplace-category-groups/{uuid}/ Retrieve a category group
POST /api/marketplace-category-groups/ Create a category group
PUT /api/marketplace-category-groups/{uuid}/ Update a category group
PATCH /api/marketplace-category-groups/{uuid}/ Partially update a category group
DELETE /api/marketplace-category-groups/{uuid}/ Delete a category group

List category groups

Returns a paginated list of category groups.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-category-groups/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.category_group_field_enum import CategoryGroupFieldEnum # (1)
from waldur_api_client.api.marketplace_category_groups import marketplace_category_groups_list # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_category_groups_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: CategoryGroupFieldEnum
  2. API Source: marketplace_category_groups_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceCategoryGroupsList } from 'waldur-js-client';

try {
  const response = await marketplaceCategoryGroupsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
field array
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
title string

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
url string (uri)
uuid string (uuid)
title string
description string
icon string (uri)

Retrieve a category group

Returns details of a specific category group.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-category-groups/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.category_group_field_enum import CategoryGroupFieldEnum # (1)
from waldur_api_client.api.marketplace_category_groups import marketplace_category_groups_retrieve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_category_groups_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. Model Source: CategoryGroupFieldEnum
  2. API Source: marketplace_category_groups_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceCategoryGroupsRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceCategoryGroupsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type
field array

200 -

Field Type
url string (uri)
uuid string (uuid)
title string
description string
icon string (uri)

Create a category group

Creates a new category group. Requires staff permissions.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/marketplace-category-groups/ \
  Authorization:"Token YOUR_API_TOKEN" \
  title="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.category_group_request import CategoryGroupRequest # (1)
from waldur_api_client.api.marketplace_category_groups import marketplace_category_groups_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = CategoryGroupRequest(
    title="string-value"
)
response = marketplace_category_groups_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: CategoryGroupRequest
  2. API Source: marketplace_category_groups_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceCategoryGroupsCreate } from 'waldur-js-client';

try {
  const response = await marketplaceCategoryGroupsCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "title": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required
title string ✓
description string
icon string (binary)

201 -

Field Type
url string (uri)
uuid string (uuid)
title string
description string
icon string (uri)

Update a category group

Updates an existing category group. Requires staff permissions.

1
2
3
4
5
http \
  PUT \
  https://api.example.com/api/marketplace-category-groups/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  title="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.category_group_request import CategoryGroupRequest # (1)
from waldur_api_client.api.marketplace_category_groups import marketplace_category_groups_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = CategoryGroupRequest(
    title="string-value"
)
response = marketplace_category_groups_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: CategoryGroupRequest
  2. API Source: marketplace_category_groups_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { marketplaceCategoryGroupsUpdate } from 'waldur-js-client';

try {
  const response = await marketplaceCategoryGroupsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "title": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
title string ✓
description string
icon string (binary)

200 -

Field Type
url string (uri)
uuid string (uuid)
title string
description string
icon string (uri)

Partially update a category group

Partially updates an existing category group. Requires staff permissions.

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/marketplace-category-groups/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_category_group_request import PatchedCategoryGroupRequest # (1)
from waldur_api_client.api.marketplace_category_groups import marketplace_category_groups_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedCategoryGroupRequest()
response = marketplace_category_groups_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedCategoryGroupRequest
  2. API Source: marketplace_category_groups_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceCategoryGroupsPartialUpdate } from 'waldur-js-client';

try {
  const response = await marketplaceCategoryGroupsPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
title string
description string
icon string (binary)

200 -

Field Type
url string (uri)
uuid string (uuid)
title string
description string
icon string (uri)

Delete a category group

Deletes a category group. Requires staff permissions.

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/marketplace-category-groups/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_category_groups import marketplace_category_groups_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_category_groups_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_category_groups_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceCategoryGroupsDestroy } from 'waldur-js-client';

try {
  const response = await marketplaceCategoryGroupsDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Marketplace Category Help Articles

Operations Summary

Method Endpoint Description
GET /api/marketplace-category-help-articles/ List category help articles
GET /api/marketplace-category-help-articles/{id}/ Retrieve a category help article
POST /api/marketplace-category-help-articles/ Create a category help article
PUT /api/marketplace-category-help-articles/{id}/ Update a category help article
PATCH /api/marketplace-category-help-articles/{id}/ Partially update a category help article
DELETE /api/marketplace-category-help-articles/{id}/ Delete a category help article

List category help articles

Returns a paginated list of all help articles associated with marketplace categories.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-category-help-articles/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_category_help_articles import marketplace_category_help_articles_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_category_help_articles_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: marketplace_category_help_articles_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceCategoryHelpArticlesList } from 'waldur-js-client';

try {
  const response = await marketplaceCategoryHelpArticlesList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
title string
url string (uri)
categories array of objects
categories.url string (uri)
categories.uuid string (uuid)
categories.title string

Retrieve a category help article

Returns the details of a specific help article, identified by its ID.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-category-help-articles/123/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_category_help_articles import marketplace_category_help_articles_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_category_help_articles_retrieve.sync(
    id=123,
    client=client
)

print(response)
  1. API Source: marketplace_category_help_articles_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceCategoryHelpArticlesRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceCategoryHelpArticlesRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "id": 123
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
id integer ✓ A unique integer value identifying this category help article.

200 -

Field Type
title string
url string (uri)
categories array of objects
categories.url string (uri)
categories.uuid string (uuid)
categories.title string

Create a category help article

Creates a new help article and associates it with one or more categories. Requires staff permissions.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/marketplace-category-help-articles/ \
  Authorization:"Token YOUR_API_TOKEN" \
  url="https://api.example.com/api/url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  categories:='[]'

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.category_help_articles_request import CategoryHelpArticlesRequest # (1)
from waldur_api_client.api.marketplace_category_help_articles import marketplace_category_help_articles_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = CategoryHelpArticlesRequest(
    url="https://api.example.com/api/url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    categories=[]
)
response = marketplace_category_help_articles_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: CategoryHelpArticlesRequest
  2. API Source: marketplace_category_help_articles_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { marketplaceCategoryHelpArticlesCreate } from 'waldur-js-client';

try {
  const response = await marketplaceCategoryHelpArticlesCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "url": "https://api.example.com/api/url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "categories": []
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required
title string
url string (uri) ✓
categories array of objects ✓
categories.title string ✓

201 -

Field Type
title string
url string (uri)
categories array of objects
categories.url string (uri)
categories.uuid string (uuid)
categories.title string

Update a category help article

Updates an existing help article. Requires staff permissions.

1
2
3
4
5
6
http \
  PUT \
  https://api.example.com/api/marketplace-category-help-articles/123/ \
  Authorization:"Token YOUR_API_TOKEN" \
  url="https://api.example.com/api/url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  categories:='[]'

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.category_help_articles_request import CategoryHelpArticlesRequest # (1)
from waldur_api_client.api.marketplace_category_help_articles import marketplace_category_help_articles_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = CategoryHelpArticlesRequest(
    url="https://api.example.com/api/url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    categories=[]
)
response = marketplace_category_help_articles_update.sync(
    id=123,
    client=client,
    body=body_data
)

print(response)
  1. Model Source: CategoryHelpArticlesRequest
  2. API Source: marketplace_category_help_articles_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { marketplaceCategoryHelpArticlesUpdate } from 'waldur-js-client';

try {
  const response = await marketplaceCategoryHelpArticlesUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "id": 123
  },
  body: {
    "url": "https://api.example.com/api/url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "categories": []
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
id integer ✓ A unique integer value identifying this category help article.
Field Type Required
title string
url string (uri) ✓
categories array of objects ✓
categories.title string ✓

200 -

Field Type
title string
url string (uri)
categories array of objects
categories.url string (uri)
categories.uuid string (uuid)
categories.title string

Partially update a category help article

Partially updates an existing help article. Requires staff permissions.

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/marketplace-category-help-articles/123/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_category_help_articles_request import PatchedCategoryHelpArticlesRequest # (1)
from waldur_api_client.api.marketplace_category_help_articles import marketplace_category_help_articles_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedCategoryHelpArticlesRequest()
response = marketplace_category_help_articles_partial_update.sync(
    id=123,
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedCategoryHelpArticlesRequest
  2. API Source: marketplace_category_help_articles_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceCategoryHelpArticlesPartialUpdate } from 'waldur-js-client';

try {
  const response = await marketplaceCategoryHelpArticlesPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "id": 123
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
id integer ✓ A unique integer value identifying this category help article.
Field Type Required
title string
url string (uri)
categories array of objects
categories.title string ✓

200 -

Field Type
title string
url string (uri)
categories array of objects
categories.url string (uri)
categories.uuid string (uuid)
categories.title string

Delete a category help article

Deletes a help article. Requires staff permissions.

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/marketplace-category-help-articles/123/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_category_help_articles import marketplace_category_help_articles_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_category_help_articles_destroy.sync(
    id=123,
    client=client
)

print(response)
  1. API Source: marketplace_category_help_articles_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceCategoryHelpArticlesDestroy } from 'waldur-js-client';

try {
  const response = await marketplaceCategoryHelpArticlesDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "id": 123
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
id integer ✓ A unique integer value identifying this category help article.

204 - No response body

Marketplace Global Categories

Operations Summary

Method Endpoint Description
GET /api/marketplace-global-categories/ Get resource counts by category

Get resource counts by category

1
2
3
4
5
    Returns a dictionary mapping marketplace category UUIDs to the count of active (non-terminated)
    resources the current user has access to within that category. This is primarily used for UI
    dashboards or sidebars to display the number of resources in each category filter.

    The counts can be further filtered by providing a `project_uuid` or `customer_uuid`.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-global-categories/ \
  Authorization:"Token YOUR_API_TOKEN"

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_global_categories import marketplace_global_categories_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_global_categories_retrieve.sync(client=client)

print(response)
  1. API Source: marketplace_global_categories_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceGlobalCategoriesRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceGlobalCategoriesRetrieve({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
customer_uuid string (uuid) Filter counts by resources within a specific customer.
project_uuid string (uuid) Filter counts by resources within a specific project.

200 -

Marketplace Sections

Operations Summary

Method Endpoint Description
GET /api/marketplace-sections/ List sections
GET /api/marketplace-sections/{key}/ Retrieve a section
POST /api/marketplace-sections/ Create a section
PUT /api/marketplace-sections/{key}/ Update a section
PATCH /api/marketplace-sections/{key}/ Partially update a section
DELETE /api/marketplace-sections/{key}/ Delete a section

List sections

Returns a paginated list of all sections. Sections are used to group attributes within a category.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-sections/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_sections import marketplace_sections_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_sections_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: marketplace_sections_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceSectionsList } from 'waldur-js-client';

try {
  const response = await marketplaceSectionsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
key string
created string (date-time)
title string
category string (uri)
category_title string
is_standalone boolean Whether section is rendered as a separate tab.

Retrieve a section

Returns the details of a specific section, identified by its key.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-sections/ssh-rsa AAAAB3NzaC1yc2EAAA.../ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_sections import marketplace_sections_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_sections_retrieve.sync(
    key="ssh-rsa AAAAB3NzaC1yc2EAAA...",
    client=client
)

print(response)
  1. API Source: marketplace_sections_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceSectionsRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceSectionsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "key": "ssh-rsa AAAAB3NzaC1yc2EAAA..."
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
key string ✓ A unique value identifying this section.

200 -

Field Type Description
url string (uri)
key string
created string (date-time)
title string
category string (uri)
category_title string
is_standalone boolean Whether section is rendered as a separate tab.

Create a section

Creates a new section within a category. Requires staff permissions.

1
2
3
4
5
6
7
http \
  POST \
  https://api.example.com/api/marketplace-sections/ \
  Authorization:"Token YOUR_API_TOKEN" \
  key="ssh-rsa AAAAB3NzaC1yc2EAAA..." \
  title="string-value" \
  category="https://api.example.com/api/category/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.section_request import SectionRequest # (1)
from waldur_api_client.api.marketplace_sections import marketplace_sections_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = SectionRequest(
    key="ssh-rsa AAAAB3NzaC1yc2EAAA...",
    title="string-value",
    category="https://api.example.com/api/category/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = marketplace_sections_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: SectionRequest
  2. API Source: marketplace_sections_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
import { marketplaceSectionsCreate } from 'waldur-js-client';

try {
  const response = await marketplaceSectionsCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "key": "ssh-rsa AAAAB3NzaC1yc2EAAA...",
    "title": "string-value",
    "category": "https://api.example.com/api/category/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
key string ✓
title string ✓
category string (uri) ✓
is_standalone boolean Whether section is rendered as a separate tab.

201 -

Field Type Description
url string (uri)
key string
created string (date-time)
title string
category string (uri)
category_title string
is_standalone boolean Whether section is rendered as a separate tab.

Update a section

Updates an existing section. Requires staff permissions.

1
2
3
4
5
6
7
http \
  PUT \
  https://api.example.com/api/marketplace-sections/ssh-rsa AAAAB3NzaC1yc2EAAA.../ \
  Authorization:"Token YOUR_API_TOKEN" \
  key="ssh-rsa AAAAB3NzaC1yc2EAAA..." \
  title="string-value" \
  category="https://api.example.com/api/category/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.section_request import SectionRequest # (1)
from waldur_api_client.api.marketplace_sections import marketplace_sections_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = SectionRequest(
    key="ssh-rsa AAAAB3NzaC1yc2EAAA...",
    title="string-value",
    category="https://api.example.com/api/category/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = marketplace_sections_update.sync(
    key="ssh-rsa AAAAB3NzaC1yc2EAAA...",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: SectionRequest
  2. API Source: marketplace_sections_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
import { marketplaceSectionsUpdate } from 'waldur-js-client';

try {
  const response = await marketplaceSectionsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "key": "ssh-rsa AAAAB3NzaC1yc2EAAA..."
  },
  body: {
    "key": "ssh-rsa AAAAB3NzaC1yc2EAAA...",
    "title": "string-value",
    "category": "https://api.example.com/api/category/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
key string ✓ A unique value identifying this section.
Field Type Required Description
key string ✓
title string ✓
category string (uri) ✓
is_standalone boolean Whether section is rendered as a separate tab.

200 -

Field Type Description
url string (uri)
key string
created string (date-time)
title string
category string (uri)
category_title string
is_standalone boolean Whether section is rendered as a separate tab.

Partially update a section

Partially updates an existing section. Requires staff permissions.

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/marketplace-sections/ssh-rsa AAAAB3NzaC1yc2EAAA.../ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_section_request import PatchedSectionRequest # (1)
from waldur_api_client.api.marketplace_sections import marketplace_sections_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedSectionRequest()
response = marketplace_sections_partial_update.sync(
    key="ssh-rsa AAAAB3NzaC1yc2EAAA...",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedSectionRequest
  2. API Source: marketplace_sections_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceSectionsPartialUpdate } from 'waldur-js-client';

try {
  const response = await marketplaceSectionsPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "key": "ssh-rsa AAAAB3NzaC1yc2EAAA..."
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
key string ✓ A unique value identifying this section.
Field Type Required Description
key string
title string
category string (uri)
is_standalone boolean Whether section is rendered as a separate tab.

200 -

Field Type Description
url string (uri)
key string
created string (date-time)
title string
category string (uri)
category_title string
is_standalone boolean Whether section is rendered as a separate tab.

Delete a section

Deletes a section. Requires staff permissions.

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/marketplace-sections/ssh-rsa AAAAB3NzaC1yc2EAAA.../ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_sections import marketplace_sections_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_sections_destroy.sync(
    key="ssh-rsa AAAAB3NzaC1yc2EAAA...",
    client=client
)

print(response)
  1. API Source: marketplace_sections_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceSectionsDestroy } from 'waldur-js-client';

try {
  const response = await marketplaceSectionsDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "key": "ssh-rsa AAAAB3NzaC1yc2EAAA..."
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
key string ✓ A unique value identifying this section.

204 - No response body

Checklists

Checklists Admin Question Dependencies

Operations Summary

Method Endpoint Description
GET /api/checklists-admin-question-dependencies/ List Checklists Admin Question Dependencies
GET /api/checklists-admin-question-dependencies/{uuid}/ Retrieve
POST /api/checklists-admin-question-dependencies/ Create
PUT /api/checklists-admin-question-dependencies/{uuid}/ Update
PATCH /api/checklists-admin-question-dependencies/{uuid}/ Partial Update
DELETE /api/checklists-admin-question-dependencies/{uuid}/ Delete

List Checklists Admin Question Dependencies

1
2
3
4
http \
  GET \
  https://api.example.com/api/checklists-admin-question-dependencies/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.checklists_admin_question_dependencies import checklists_admin_question_dependencies_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = checklists_admin_question_dependencies_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: checklists_admin_question_dependencies_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { checklistsAdminQuestionDependenciesList } from 'waldur-js-client';

try {
  const response = await checklistsAdminQuestionDependenciesList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
depends_on_question_uuid string (uuid)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
question_uuid string (uuid)

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid)
url string (uri)
question string (uri)
question_name string
depends_on_question string (uri)
depends_on_question_name string
required_answer_value any The answer value(s) that make this question visible
operator string
Enum: equals, not_equals, contains, in, not_in

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/checklists-admin-question-dependencies/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.checklists_admin_question_dependencies import checklists_admin_question_dependencies_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = checklists_admin_question_dependencies_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: checklists_admin_question_dependencies_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { checklistsAdminQuestionDependenciesRetrieve } from 'waldur-js-client';

try {
  const response = await checklistsAdminQuestionDependenciesRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
uuid string (uuid)
url string (uri)
question string (uri)
question_name string
depends_on_question string (uri)
depends_on_question_name string
required_answer_value any The answer value(s) that make this question visible
operator string
Enum: equals, not_equals, contains, in, not_in

Create

1
2
3
4
5
6
7
http \
  POST \
  https://api.example.com/api/checklists-admin-question-dependencies/ \
  Authorization:"Token YOUR_API_TOKEN" \
  question="https://api.example.com/api/question/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  depends_on_question="https://api.example.com/api/depends-on-question/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  required_answer_value=null

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.question_dependency_request import QuestionDependencyRequest # (1)
from waldur_api_client.api.checklists_admin_question_dependencies import checklists_admin_question_dependencies_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = QuestionDependencyRequest(
    question="https://api.example.com/api/question/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    depends_on_question="https://api.example.com/api/depends-on-question/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    required_answer_value=null
)
response = checklists_admin_question_dependencies_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: QuestionDependencyRequest
  2. API Source: checklists_admin_question_dependencies_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
import { checklistsAdminQuestionDependenciesCreate } from 'waldur-js-client';

try {
  const response = await checklistsAdminQuestionDependenciesCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "question": "https://api.example.com/api/question/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "depends_on_question": "https://api.example.com/api/depends-on-question/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "required_answer_value": null
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
question string (uri) ✓
depends_on_question string (uri) ✓
required_answer_value any ✓ The answer value(s) that make this question visible
operator string
Enum: equals, not_equals, contains, in, not_in

201 -

Field Type Description
uuid string (uuid)
url string (uri)
question string (uri)
question_name string
depends_on_question string (uri)
depends_on_question_name string
required_answer_value any The answer value(s) that make this question visible
operator string
Enum: equals, not_equals, contains, in, not_in

Update

1
2
3
4
5
6
7
http \
  PUT \
  https://api.example.com/api/checklists-admin-question-dependencies/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  question="https://api.example.com/api/question/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  depends_on_question="https://api.example.com/api/depends-on-question/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  required_answer_value=null

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.question_dependency_request import QuestionDependencyRequest # (1)
from waldur_api_client.api.checklists_admin_question_dependencies import checklists_admin_question_dependencies_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = QuestionDependencyRequest(
    question="https://api.example.com/api/question/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    depends_on_question="https://api.example.com/api/depends-on-question/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    required_answer_value=null
)
response = checklists_admin_question_dependencies_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: QuestionDependencyRequest
  2. API Source: checklists_admin_question_dependencies_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
import { checklistsAdminQuestionDependenciesUpdate } from 'waldur-js-client';

try {
  const response = await checklistsAdminQuestionDependenciesUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "question": "https://api.example.com/api/question/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "depends_on_question": "https://api.example.com/api/depends-on-question/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "required_answer_value": null
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
question string (uri) ✓
depends_on_question string (uri) ✓
required_answer_value any ✓ The answer value(s) that make this question visible
operator string
Enum: equals, not_equals, contains, in, not_in

200 -

Field Type Description
uuid string (uuid)
url string (uri)
question string (uri)
question_name string
depends_on_question string (uri)
depends_on_question_name string
required_answer_value any The answer value(s) that make this question visible
operator string
Enum: equals, not_equals, contains, in, not_in

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/checklists-admin-question-dependencies/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_question_dependency_request import PatchedQuestionDependencyRequest # (1)
from waldur_api_client.api.checklists_admin_question_dependencies import checklists_admin_question_dependencies_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedQuestionDependencyRequest()
response = checklists_admin_question_dependencies_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedQuestionDependencyRequest
  2. API Source: checklists_admin_question_dependencies_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { checklistsAdminQuestionDependenciesPartialUpdate } from 'waldur-js-client';

try {
  const response = await checklistsAdminQuestionDependenciesPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
question string (uri)
depends_on_question string (uri)
required_answer_value any The answer value(s) that make this question visible
operator string
Enum: equals, not_equals, contains, in, not_in

200 -

Field Type Description
uuid string (uuid)
url string (uri)
question string (uri)
question_name string
depends_on_question string (uri)
depends_on_question_name string
required_answer_value any The answer value(s) that make this question visible
operator string
Enum: equals, not_equals, contains, in, not_in

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/checklists-admin-question-dependencies/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.checklists_admin_question_dependencies import checklists_admin_question_dependencies_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = checklists_admin_question_dependencies_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: checklists_admin_question_dependencies_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { checklistsAdminQuestionDependenciesDestroy } from 'waldur-js-client';

try {
  const response = await checklistsAdminQuestionDependenciesDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Checklists Admin Question Options

Operations Summary

Method Endpoint Description
GET /api/checklists-admin-question-options/ List Checklists Admin Question Options
GET /api/checklists-admin-question-options/{uuid}/ Retrieve
POST /api/checklists-admin-question-options/ Create
PUT /api/checklists-admin-question-options/{uuid}/ Update
PATCH /api/checklists-admin-question-options/{uuid}/ Partial Update
DELETE /api/checklists-admin-question-options/{uuid}/ Delete

List Checklists Admin Question Options

1
2
3
4
http \
  GET \
  https://api.example.com/api/checklists-admin-question-options/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.checklists_admin_question_options import checklists_admin_question_options_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = checklists_admin_question_options_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: checklists_admin_question_options_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { checklistsAdminQuestionOptionsList } from 'waldur-js-client';

try {
  const response = await checklistsAdminQuestionOptionsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
question_uuid string (uuid)

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
uuid string (uuid)
label string
order integer
url string (uri)
question string (uri)
question_uuid string (uuid)

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/checklists-admin-question-options/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.checklists_admin_question_options import checklists_admin_question_options_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = checklists_admin_question_options_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: checklists_admin_question_options_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { checklistsAdminQuestionOptionsRetrieve } from 'waldur-js-client';

try {
  const response = await checklistsAdminQuestionOptionsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
uuid string (uuid)
label string
order integer
url string (uri)
question string (uri)
question_uuid string (uuid)

Create

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/checklists-admin-question-options/ \
  Authorization:"Token YOUR_API_TOKEN" \
  label="string-value" \
  question="https://api.example.com/api/question/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.question_options_admin_request import QuestionOptionsAdminRequest # (1)
from waldur_api_client.api.checklists_admin_question_options import checklists_admin_question_options_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = QuestionOptionsAdminRequest(
    label="string-value",
    question="https://api.example.com/api/question/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = checklists_admin_question_options_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: QuestionOptionsAdminRequest
  2. API Source: checklists_admin_question_options_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { checklistsAdminQuestionOptionsCreate } from 'waldur-js-client';

try {
  const response = await checklistsAdminQuestionOptionsCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "label": "string-value",
    "question": "https://api.example.com/api/question/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required
label string ✓
order integer
question string (uri) ✓

201 -

Field Type
uuid string (uuid)
label string
order integer
url string (uri)
question string (uri)
question_uuid string (uuid)

Update

1
2
3
4
5
6
http \
  PUT \
  https://api.example.com/api/checklists-admin-question-options/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  label="string-value" \
  question="https://api.example.com/api/question/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.question_options_admin_request import QuestionOptionsAdminRequest # (1)
from waldur_api_client.api.checklists_admin_question_options import checklists_admin_question_options_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = QuestionOptionsAdminRequest(
    label="string-value",
    question="https://api.example.com/api/question/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = checklists_admin_question_options_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: QuestionOptionsAdminRequest
  2. API Source: checklists_admin_question_options_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { checklistsAdminQuestionOptionsUpdate } from 'waldur-js-client';

try {
  const response = await checklistsAdminQuestionOptionsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "label": "string-value",
    "question": "https://api.example.com/api/question/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
label string ✓
order integer
question string (uri) ✓

200 -

Field Type
uuid string (uuid)
label string
order integer
url string (uri)
question string (uri)
question_uuid string (uuid)

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/checklists-admin-question-options/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_question_options_admin_request import PatchedQuestionOptionsAdminRequest # (1)
from waldur_api_client.api.checklists_admin_question_options import checklists_admin_question_options_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedQuestionOptionsAdminRequest()
response = checklists_admin_question_options_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedQuestionOptionsAdminRequest
  2. API Source: checklists_admin_question_options_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { checklistsAdminQuestionOptionsPartialUpdate } from 'waldur-js-client';

try {
  const response = await checklistsAdminQuestionOptionsPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
label string
order integer

200 -

Field Type
uuid string (uuid)
label string
order integer
url string (uri)
question string (uri)
question_uuid string (uuid)

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/checklists-admin-question-options/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.checklists_admin_question_options import checklists_admin_question_options_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = checklists_admin_question_options_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: checklists_admin_question_options_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { checklistsAdminQuestionOptionsDestroy } from 'waldur-js-client';

try {
  const response = await checklistsAdminQuestionOptionsDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Checklists Admin Questions

Operations Summary

Method Endpoint Description
GET /api/checklists-admin-questions/ List Checklists Admin Questions
GET /api/checklists-admin-questions/{uuid}/ Retrieve
POST /api/checklists-admin-questions/ Create
PUT /api/checklists-admin-questions/{uuid}/ Update
PATCH /api/checklists-admin-questions/{uuid}/ Partial Update
DELETE /api/checklists-admin-questions/{uuid}/ Delete

List Checklists Admin Questions

1
2
3
4
http \
  GET \
  https://api.example.com/api/checklists-admin-questions/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.checklist_type_enum import ChecklistTypeEnum # (1)
from waldur_api_client.api.checklists_admin_questions import checklists_admin_questions_list # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = checklists_admin_questions_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: ChecklistTypeEnum
  2. API Source: checklists_admin_questions_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { checklistsAdminQuestionsList } from 'waldur-js-client';

try {
  const response = await checklistsAdminQuestionsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
checklist_type string Type of compliance this checklist addresses


Enum: project_compliance, proposal_compliance, offering_compliance, project_metadata, onboarding_customer, onboarding_intent
checklist_uuid string (uuid)
has_onboarding_mapping boolean Filter questions that have onboarding metadata mapping
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid)
required boolean
description string
user_guidance string Additional guidance text visible to users when answering and reviewing
question_options array of objects
question_options.uuid string (uuid)
question_options.label string
question_options.order integer
question_options.url string (uri)
question_options.question string (uri)
question_options.question_uuid string (uuid)
question_type any Type of question and expected answer format
order integer
min_value string (decimal) Minimum value allowed for NUMBER, YEAR, and RATING type questions
max_value string (decimal) Maximum value allowed for NUMBER, YEAR, and RATING type questions
allowed_file_types any List of allowed file extensions (e.g., ['.pdf', '.doc', '.docx']). If empty, all file types are allowed.
allowed_mime_types any List of allowed MIME types (e.g., ['application/pdf', 'application/msword']). If empty, MIME type validation is not enforced. When both extensions and MIME types are specified, files must match both criteria for security.
max_file_size_mb integer Maximum file size in megabytes. If not set, no size limit is enforced.
max_files_count integer Maximum number of files allowed for MULTIPLE_FILES type questions. If not set, no count limit is enforced.
operator any
review_answer_value any Answer value that trigger review.
always_requires_review boolean This question always requires review regardless of answer
guidance_answer_value any Answer value that triggers display of user guidance.
guidance_operator any Operator to use when comparing answer with guidance_answer_value
always_show_guidance boolean Show user guidance always, regardless of answer. If False, guidance is conditional on answer matching guidance_answer_value with guidance_operator
dependency_logic_operator any Defines how multiple dependencies are evaluated. AND: All dependencies must be satisfied. OR: At least one dependency must be satisfied.
url string (uri)
checklist_name string
checklist_uuid string (uuid)
checklist_type string
checklist string (uri)

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/checklists-admin-questions/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.checklists_admin_questions import checklists_admin_questions_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = checklists_admin_questions_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: checklists_admin_questions_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { checklistsAdminQuestionsRetrieve } from 'waldur-js-client';

try {
  const response = await checklistsAdminQuestionsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
uuid string (uuid)
required boolean
description string
user_guidance string Additional guidance text visible to users when answering and reviewing
question_options array of objects
question_options.uuid string (uuid)
question_options.label string
question_options.order integer
question_options.url string (uri)
question_options.question string (uri)
question_options.question_uuid string (uuid)
question_type any Type of question and expected answer format
order integer
min_value string (decimal) Minimum value allowed for NUMBER, YEAR, and RATING type questions
max_value string (decimal) Maximum value allowed for NUMBER, YEAR, and RATING type questions
allowed_file_types any List of allowed file extensions (e.g., ['.pdf', '.doc', '.docx']). If empty, all file types are allowed.
allowed_mime_types any List of allowed MIME types (e.g., ['application/pdf', 'application/msword']). If empty, MIME type validation is not enforced. When both extensions and MIME types are specified, files must match both criteria for security.
max_file_size_mb integer Maximum file size in megabytes. If not set, no size limit is enforced.
max_files_count integer Maximum number of files allowed for MULTIPLE_FILES type questions. If not set, no count limit is enforced.
operator any
review_answer_value any Answer value that trigger review.
always_requires_review boolean This question always requires review regardless of answer
guidance_answer_value any Answer value that triggers display of user guidance.
guidance_operator any Operator to use when comparing answer with guidance_answer_value
always_show_guidance boolean Show user guidance always, regardless of answer. If False, guidance is conditional on answer matching guidance_answer_value with guidance_operator
dependency_logic_operator any Defines how multiple dependencies are evaluated. AND: All dependencies must be satisfied. OR: At least one dependency must be satisfied.
url string (uri)
checklist_name string
checklist_uuid string (uuid)
checklist_type string
checklist string (uri)

Create

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/checklists-admin-questions/ \
  Authorization:"Token YOUR_API_TOKEN" \
  checklist="https://api.example.com/api/checklist/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.question_admin_request import QuestionAdminRequest # (1)
from waldur_api_client.api.checklists_admin_questions import checklists_admin_questions_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = QuestionAdminRequest(
    checklist="https://api.example.com/api/checklist/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = checklists_admin_questions_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: QuestionAdminRequest
  2. API Source: checklists_admin_questions_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { checklistsAdminQuestionsCreate } from 'waldur-js-client';

try {
  const response = await checklistsAdminQuestionsCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "checklist": "https://api.example.com/api/checklist/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
required boolean
description string
user_guidance string Additional guidance text visible to users when answering and reviewing
question_type any Type of question and expected answer format
order integer
min_value string (decimal) Minimum value allowed for NUMBER, YEAR, and RATING type questions
max_value string (decimal) Maximum value allowed for NUMBER, YEAR, and RATING type questions
allowed_file_types any List of allowed file extensions (e.g., ['.pdf', '.doc', '.docx']). If empty, all file types are allowed.
allowed_mime_types any List of allowed MIME types (e.g., ['application/pdf', 'application/msword']). If empty, MIME type validation is not enforced. When both extensions and MIME types are specified, files must match both criteria for security.
max_file_size_mb integer Maximum file size in megabytes. If not set, no size limit is enforced.
max_files_count integer Maximum number of files allowed for MULTIPLE_FILES type questions. If not set, no count limit is enforced.
operator any
review_answer_value any Answer value that trigger review.
always_requires_review boolean This question always requires review regardless of answer
guidance_answer_value any Answer value that triggers display of user guidance.
guidance_operator any Operator to use when comparing answer with guidance_answer_value
always_show_guidance boolean Show user guidance always, regardless of answer. If False, guidance is conditional on answer matching guidance_answer_value with guidance_operator
dependency_logic_operator any Defines how multiple dependencies are evaluated. AND: All dependencies must be satisfied. OR: At least one dependency must be satisfied.
checklist string (uri) ✓

201 -

Field Type Description
uuid string (uuid)
required boolean
description string
user_guidance string Additional guidance text visible to users when answering and reviewing
question_options array of objects
question_options.uuid string (uuid)
question_options.label string
question_options.order integer
question_options.url string (uri)
question_options.question string (uri)
question_options.question_uuid string (uuid)
question_type any Type of question and expected answer format
order integer
min_value string (decimal) Minimum value allowed for NUMBER, YEAR, and RATING type questions
max_value string (decimal) Maximum value allowed for NUMBER, YEAR, and RATING type questions
allowed_file_types any List of allowed file extensions (e.g., ['.pdf', '.doc', '.docx']). If empty, all file types are allowed.
allowed_mime_types any List of allowed MIME types (e.g., ['application/pdf', 'application/msword']). If empty, MIME type validation is not enforced. When both extensions and MIME types are specified, files must match both criteria for security.
max_file_size_mb integer Maximum file size in megabytes. If not set, no size limit is enforced.
max_files_count integer Maximum number of files allowed for MULTIPLE_FILES type questions. If not set, no count limit is enforced.
operator any
review_answer_value any Answer value that trigger review.
always_requires_review boolean This question always requires review regardless of answer
guidance_answer_value any Answer value that triggers display of user guidance.
guidance_operator any Operator to use when comparing answer with guidance_answer_value
always_show_guidance boolean Show user guidance always, regardless of answer. If False, guidance is conditional on answer matching guidance_answer_value with guidance_operator
dependency_logic_operator any Defines how multiple dependencies are evaluated. AND: All dependencies must be satisfied. OR: At least one dependency must be satisfied.
url string (uri)
checklist_name string
checklist_uuid string (uuid)
checklist_type string
checklist string (uri)

Update

1
2
3
4
5
http \
  PUT \
  https://api.example.com/api/checklists-admin-questions/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  checklist="https://api.example.com/api/checklist/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.question_admin_request import QuestionAdminRequest # (1)
from waldur_api_client.api.checklists_admin_questions import checklists_admin_questions_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = QuestionAdminRequest(
    checklist="https://api.example.com/api/checklist/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = checklists_admin_questions_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: QuestionAdminRequest
  2. API Source: checklists_admin_questions_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { checklistsAdminQuestionsUpdate } from 'waldur-js-client';

try {
  const response = await checklistsAdminQuestionsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "checklist": "https://api.example.com/api/checklist/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
required boolean
description string
user_guidance string Additional guidance text visible to users when answering and reviewing
question_type any Type of question and expected answer format
order integer
min_value string (decimal) Minimum value allowed for NUMBER, YEAR, and RATING type questions
max_value string (decimal) Maximum value allowed for NUMBER, YEAR, and RATING type questions
allowed_file_types any List of allowed file extensions (e.g., ['.pdf', '.doc', '.docx']). If empty, all file types are allowed.
allowed_mime_types any List of allowed MIME types (e.g., ['application/pdf', 'application/msword']). If empty, MIME type validation is not enforced. When both extensions and MIME types are specified, files must match both criteria for security.
max_file_size_mb integer Maximum file size in megabytes. If not set, no size limit is enforced.
max_files_count integer Maximum number of files allowed for MULTIPLE_FILES type questions. If not set, no count limit is enforced.
operator any
review_answer_value any Answer value that trigger review.
always_requires_review boolean This question always requires review regardless of answer
guidance_answer_value any Answer value that triggers display of user guidance.
guidance_operator any Operator to use when comparing answer with guidance_answer_value
always_show_guidance boolean Show user guidance always, regardless of answer. If False, guidance is conditional on answer matching guidance_answer_value with guidance_operator
dependency_logic_operator any Defines how multiple dependencies are evaluated. AND: All dependencies must be satisfied. OR: At least one dependency must be satisfied.
checklist string (uri) ✓

200 -

Field Type Description
uuid string (uuid)
required boolean
description string
user_guidance string Additional guidance text visible to users when answering and reviewing
question_options array of objects
question_options.uuid string (uuid)
question_options.label string
question_options.order integer
question_options.url string (uri)
question_options.question string (uri)
question_options.question_uuid string (uuid)
question_type any Type of question and expected answer format
order integer
min_value string (decimal) Minimum value allowed for NUMBER, YEAR, and RATING type questions
max_value string (decimal) Maximum value allowed for NUMBER, YEAR, and RATING type questions
allowed_file_types any List of allowed file extensions (e.g., ['.pdf', '.doc', '.docx']). If empty, all file types are allowed.
allowed_mime_types any List of allowed MIME types (e.g., ['application/pdf', 'application/msword']). If empty, MIME type validation is not enforced. When both extensions and MIME types are specified, files must match both criteria for security.
max_file_size_mb integer Maximum file size in megabytes. If not set, no size limit is enforced.
max_files_count integer Maximum number of files allowed for MULTIPLE_FILES type questions. If not set, no count limit is enforced.
operator any
review_answer_value any Answer value that trigger review.
always_requires_review boolean This question always requires review regardless of answer
guidance_answer_value any Answer value that triggers display of user guidance.
guidance_operator any Operator to use when comparing answer with guidance_answer_value
always_show_guidance boolean Show user guidance always, regardless of answer. If False, guidance is conditional on answer matching guidance_answer_value with guidance_operator
dependency_logic_operator any Defines how multiple dependencies are evaluated. AND: All dependencies must be satisfied. OR: At least one dependency must be satisfied.
url string (uri)
checklist_name string
checklist_uuid string (uuid)
checklist_type string
checklist string (uri)

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/checklists-admin-questions/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_question_admin_request import PatchedQuestionAdminRequest # (1)
from waldur_api_client.api.checklists_admin_questions import checklists_admin_questions_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedQuestionAdminRequest()
response = checklists_admin_questions_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedQuestionAdminRequest
  2. API Source: checklists_admin_questions_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { checklistsAdminQuestionsPartialUpdate } from 'waldur-js-client';

try {
  const response = await checklistsAdminQuestionsPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
required boolean
description string
user_guidance string Additional guidance text visible to users when answering and reviewing
question_type any Type of question and expected answer format
order integer
min_value string (decimal) Minimum value allowed for NUMBER, YEAR, and RATING type questions
max_value string (decimal) Maximum value allowed for NUMBER, YEAR, and RATING type questions
allowed_file_types any List of allowed file extensions (e.g., ['.pdf', '.doc', '.docx']). If empty, all file types are allowed.
allowed_mime_types any List of allowed MIME types (e.g., ['application/pdf', 'application/msword']). If empty, MIME type validation is not enforced. When both extensions and MIME types are specified, files must match both criteria for security.
max_file_size_mb integer Maximum file size in megabytes. If not set, no size limit is enforced.
max_files_count integer Maximum number of files allowed for MULTIPLE_FILES type questions. If not set, no count limit is enforced.
operator any
review_answer_value any Answer value that trigger review.
always_requires_review boolean This question always requires review regardless of answer
guidance_answer_value any Answer value that triggers display of user guidance.
guidance_operator any Operator to use when comparing answer with guidance_answer_value
always_show_guidance boolean Show user guidance always, regardless of answer. If False, guidance is conditional on answer matching guidance_answer_value with guidance_operator
dependency_logic_operator any Defines how multiple dependencies are evaluated. AND: All dependencies must be satisfied. OR: At least one dependency must be satisfied.
checklist string (uri)

200 -

Field Type Description
uuid string (uuid)
required boolean
description string
user_guidance string Additional guidance text visible to users when answering and reviewing
question_options array of objects
question_options.uuid string (uuid)
question_options.label string
question_options.order integer
question_options.url string (uri)
question_options.question string (uri)
question_options.question_uuid string (uuid)
question_type any Type of question and expected answer format
order integer
min_value string (decimal) Minimum value allowed for NUMBER, YEAR, and RATING type questions
max_value string (decimal) Maximum value allowed for NUMBER, YEAR, and RATING type questions
allowed_file_types any List of allowed file extensions (e.g., ['.pdf', '.doc', '.docx']). If empty, all file types are allowed.
allowed_mime_types any List of allowed MIME types (e.g., ['application/pdf', 'application/msword']). If empty, MIME type validation is not enforced. When both extensions and MIME types are specified, files must match both criteria for security.
max_file_size_mb integer Maximum file size in megabytes. If not set, no size limit is enforced.
max_files_count integer Maximum number of files allowed for MULTIPLE_FILES type questions. If not set, no count limit is enforced.
operator any
review_answer_value any Answer value that trigger review.
always_requires_review boolean This question always requires review regardless of answer
guidance_answer_value any Answer value that triggers display of user guidance.
guidance_operator any Operator to use when comparing answer with guidance_answer_value
always_show_guidance boolean Show user guidance always, regardless of answer. If False, guidance is conditional on answer matching guidance_answer_value with guidance_operator
dependency_logic_operator any Defines how multiple dependencies are evaluated. AND: All dependencies must be satisfied. OR: At least one dependency must be satisfied.
url string (uri)
checklist_name string
checklist_uuid string (uuid)
checklist_type string
checklist string (uri)

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/checklists-admin-questions/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.checklists_admin_questions import checklists_admin_questions_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = checklists_admin_questions_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: checklists_admin_questions_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { checklistsAdminQuestionsDestroy } from 'waldur-js-client';

try {
  const response = await checklistsAdminQuestionsDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Checklists Admin

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/checklists-admin/ List Checklists Admin
GET /api/checklists-admin/{uuid}/ Retrieve
POST /api/checklists-admin/ Create
PUT /api/checklists-admin/{uuid}/ Update
PATCH /api/checklists-admin/{uuid}/ Partial Update
DELETE /api/checklists-admin/{uuid}/ Delete
Other Actions
GET /api/checklists-admin/{uuid}/questions/ Return checklist questions

Core CRUD

List Checklists Admin

1
2
3
4
http \
  GET \
  https://api.example.com/api/checklists-admin/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.checklist_type_enum import ChecklistTypeEnum # (1)
from waldur_api_client.api.checklists_admin import checklists_admin_list # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = checklists_admin_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: ChecklistTypeEnum
  2. API Source: checklists_admin_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { checklistsAdminList } from 'waldur-js-client';

try {
  const response = await checklistsAdminList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
checklist_type string Type of compliance this checklist addresses


Enum: project_compliance, proposal_compliance, offering_compliance, project_metadata, onboarding_customer, onboarding_intent
checklist_type__in array Filter by multiple checklist types
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid)
url string (uri)
name string
description string
checklist_type any Type of compliance this checklist addresses
questions_count integer

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/checklists-admin/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.checklists_admin import checklists_admin_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = checklists_admin_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: checklists_admin_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { checklistsAdminRetrieve } from 'waldur-js-client';

try {
  const response = await checklistsAdminRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
uuid string (uuid)
url string (uri)
name string
description string
checklist_type any Type of compliance this checklist addresses
questions_count integer

Create

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/checklists-admin/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-checklists-admin"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.checklist_request import ChecklistRequest # (1)
from waldur_api_client.api.checklists_admin import checklists_admin_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ChecklistRequest(
    name="my-awesome-checklists-admin"
)
response = checklists_admin_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ChecklistRequest
  2. API Source: checklists_admin_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { checklistsAdminCreate } from 'waldur-js-client';

try {
  const response = await checklistsAdminCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "name": "my-awesome-checklists-admin"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
name string ✓
description string
checklist_type any Type of compliance this checklist addresses

201 -

Field Type Description
uuid string (uuid)
url string (uri)
name string
description string
checklist_type any Type of compliance this checklist addresses
questions_count integer

Update

1
2
3
4
5
http \
  PUT \
  https://api.example.com/api/checklists-admin/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-checklists-admin"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.checklist_request import ChecklistRequest # (1)
from waldur_api_client.api.checklists_admin import checklists_admin_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ChecklistRequest(
    name="my-awesome-checklists-admin"
)
response = checklists_admin_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ChecklistRequest
  2. API Source: checklists_admin_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { checklistsAdminUpdate } from 'waldur-js-client';

try {
  const response = await checklistsAdminUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-checklists-admin"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
name string ✓
description string
checklist_type any Type of compliance this checklist addresses

200 -

Field Type Description
uuid string (uuid)
url string (uri)
name string
description string
checklist_type any Type of compliance this checklist addresses
questions_count integer

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/checklists-admin/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_checklist_request import PatchedChecklistRequest # (1)
from waldur_api_client.api.checklists_admin import checklists_admin_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedChecklistRequest()
response = checklists_admin_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedChecklistRequest
  2. API Source: checklists_admin_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { checklistsAdminPartialUpdate } from 'waldur-js-client';

try {
  const response = await checklistsAdminPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
name string
description string
checklist_type any Type of compliance this checklist addresses

200 -

Field Type Description
uuid string (uuid)
url string (uri)
name string
description string
checklist_type any Type of compliance this checklist addresses
questions_count integer

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/checklists-admin/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.checklists_admin import checklists_admin_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = checklists_admin_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: checklists_admin_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { checklistsAdminDestroy } from 'waldur-js-client';

try {
  const response = await checklistsAdminDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Other Actions

Return checklist questions

Return checklist questions.

1
2
3
4
http \
  GET \
  https://api.example.com/api/checklists-admin/a1b2c3d4-e5f6-7890-abcd-ef1234567890/questions/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.checklist_type_enum import ChecklistTypeEnum # (1)
from waldur_api_client.api.checklists_admin import checklists_admin_checklist_questions # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = checklists_admin_checklist_questions.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

for item in response:
    print(item)
  1. Model Source: ChecklistTypeEnum
  2. API Source: checklists_admin_checklist_questions
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { checklistsAdminChecklistQuestions } from 'waldur-js-client';

try {
  const response = await checklistsAdminChecklistQuestions({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type Description
checklist_type string Type of compliance this checklist addresses


Enum: project_compliance, proposal_compliance, offering_compliance, project_metadata, onboarding_customer, onboarding_intent
checklist_type__in array Filter by multiple checklist types
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid)
required boolean
description string
user_guidance string Additional guidance text visible to users when answering and reviewing
question_options array of objects
question_options.uuid string (uuid)
question_options.label string
question_options.order integer
question_options.url string (uri)
question_options.question string (uri)
question_options.question_uuid string (uuid)
question_type any Type of question and expected answer format
order integer
min_value string (decimal) Minimum value allowed for NUMBER, YEAR, and RATING type questions
max_value string (decimal) Maximum value allowed for NUMBER, YEAR, and RATING type questions
allowed_file_types any List of allowed file extensions (e.g., ['.pdf', '.doc', '.docx']). If empty, all file types are allowed.
allowed_mime_types any List of allowed MIME types (e.g., ['application/pdf', 'application/msword']). If empty, MIME type validation is not enforced. When both extensions and MIME types are specified, files must match both criteria for security.
max_file_size_mb integer Maximum file size in megabytes. If not set, no size limit is enforced.
max_files_count integer Maximum number of files allowed for MULTIPLE_FILES type questions. If not set, no count limit is enforced.
operator any
review_answer_value any Answer value that trigger review.
always_requires_review boolean This question always requires review regardless of answer
guidance_answer_value any Answer value that triggers display of user guidance.
guidance_operator any Operator to use when comparing answer with guidance_answer_value
always_show_guidance boolean Show user guidance always, regardless of answer. If False, guidance is conditional on answer matching guidance_answer_value with guidance_operator
dependency_logic_operator any Defines how multiple dependencies are evaluated. AND: All dependencies must be satisfied. OR: At least one dependency must be satisfied.
url string (uri)
checklist_name string
checklist_uuid string (uuid)
checklist_type string
checklist string (uri)

Marketplace Offering User Checklist Completions

Operations Summary

Method Endpoint Description
GET /api/marketplace-offering-user-checklist-completions/ List checklist completions for offering users
GET /api/marketplace-offering-user-checklist-completions/{id}/ Retrieve a checklist completion

List checklist completions for offering users

1
2
3
    Returns a paginated list of all checklist completions for offering users that the current user is allowed to see.
    This endpoint is used by service providers to monitor compliance status and by users to see their own required checklists.
    Visibility follows the same rules as the `OfferingUsers` endpoint.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-offering-user-checklist-completions/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.user_checklist_completion_o_enum import UserChecklistCompletionOEnum # (1)
from waldur_api_client.api.marketplace_offering_user_checklist_completions import marketplace_offering_user_checklist_completions_list # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_offering_user_checklist_completions_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: UserChecklistCompletionOEnum
  2. API Source: marketplace_offering_user_checklist_completions_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceOfferingUserChecklistCompletionsList } from 'waldur-js-client';

try {
  const response = await marketplaceOfferingUserChecklistCompletionsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
created string (date-time) Created after
is_completed boolean
modified string (date-time) Modified after
o array Ordering
offering_uuid string (uuid) Filter by offering UUID
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
user_uuid string (uuid) Filter by user UUID

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid)
offering_user any
offering_user_uuid string
offering_name string
offering_uuid string
customer_provider_uuid string
customer_provider_name string
checklist_uuid string
checklist_name string
checklist_description string
is_completed boolean Whether all required questions have been answered
completion_percentage number (double)
unanswered_required_questions integer
requires_review boolean Whether any answers triggered review requirements
reviewed_by integer User who reviewed the checklist completion
reviewed_at string (date-time)
review_notes string Notes from the reviewer
created string (date-time)
modified string (date-time)

Retrieve a checklist completion

Returns the details of a specific checklist completion for an offering user.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-offering-user-checklist-completions/123/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_offering_user_checklist_completions import marketplace_offering_user_checklist_completions_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_offering_user_checklist_completions_retrieve.sync(
    id=123,
    client=client
)

print(response)
  1. API Source: marketplace_offering_user_checklist_completions_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceOfferingUserChecklistCompletionsRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceOfferingUserChecklistCompletionsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "id": 123
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
id integer ✓ A unique integer value identifying this Checklist completion.

200 -

Field Type Description
uuid string (uuid)
offering_user any
offering_user_uuid string
offering_name string
offering_uuid string
customer_provider_uuid string
customer_provider_name string
checklist_uuid string
checklist_name string
checklist_description string
is_completed boolean Whether all required questions have been answered
completion_percentage number (double)
unanswered_required_questions integer
requires_review boolean Whether any answers triggered review requirements
reviewed_by integer User who reviewed the checklist completion
reviewed_at string (date-time)
review_notes string Notes from the reviewer
created string (date-time)
modified string (date-time)

Integration

Marketplace Integration Statuses

Operations Summary

Method Endpoint Description
GET /api/marketplace-integration-statuses/ List integration statuses
GET /api/marketplace-integration-statuses/{uuid}/ Retrieve an integration status

List integration statuses

Returns a paginated list of integration statuses for offerings. This is used to monitor the connectivity and health of backend agents (e.g., site agents) associated with offerings.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-integration-statuses/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.integration_status_details_o_enum import IntegrationStatusDetailsOEnum # (1)
from waldur_api_client.models.integration_status_details_status_enum import IntegrationStatusDetailsStatusEnum # (2)
from waldur_api_client.api.marketplace_integration_statuses import marketplace_integration_statuses_list # (3)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_integration_statuses_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: IntegrationStatusDetailsOEnum
  2. Model Source: IntegrationStatusDetailsStatusEnum
  3. API Source: marketplace_integration_statuses_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceIntegrationStatusesList } from 'waldur-js-client';

try {
  const response = await marketplaceIntegrationStatusesList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
agent_type string Agent type
customer_uuid string Customer UUID
o array Ordering
offering string (uri)
offering_slug array Multiple values may be separated by commas.
offering_uuid array Multiple values may be separated by commas.
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
parent_offering_uuid string (uuid)
status array Integration status

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
status string
last_request_timestamp string (date-time)
offering string (uri)
url string (uri)

Retrieve an integration status

Returns the details of a specific integration status, including the agent type, status, and last request timestamp.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-integration-statuses/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_integration_statuses import marketplace_integration_statuses_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_integration_statuses_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_integration_statuses_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceIntegrationStatusesRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceIntegrationStatusesRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
status string
last_request_timestamp string (date-time)
offering string (uri)
url string (uri)

Marketplace Plugins

Operations Summary

Method Endpoint Description
GET /api/marketplace-plugins/ List available marketplace plugins and their components

List available marketplace plugins and their components

1
2
3
4
5
6
7
    Returns a list of all registered marketplace plugins (offering types) and the components
    associated with each. This endpoint is public and does not require authentication.

    Each plugin entry includes:
    - `offering_type`: A unique identifier for the plugin.
    - `components`: A list of components provided by the plugin, each with its `type`, `name`, `measured_unit`, and `billing_type`.
    - `available_limits`: A list of component types that support user-defined limits for this plugin.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-plugins/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_plugins import marketplace_plugins_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_plugins_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: marketplace_plugins_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplacePluginsList } from 'waldur-js-client';

try {
  const response = await marketplacePluginsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
offering_type string
components array of objects
components.type string Type identifier of the component
components.name string Display name of the component
components.measured_unit string Unit of measurement for the component
components.billing_type any Billing type for the component
available_limits array of strings

Marketplace Project Update Requests

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/marketplace-project-update-requests/ List Marketplace Project Update Requests
GET /api/marketplace-project-update-requests/{uuid}/ Retrieve
Other Actions
POST /api/marketplace-project-update-requests/{uuid}/approve/ Approve project update request
POST /api/marketplace-project-update-requests/{uuid}/reject/ Reject project update request

Core CRUD

List Marketplace Project Update Requests

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-project-update-requests/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.remote_project_update_request_state_enum import RemoteProjectUpdateRequestStateEnum # (1)
from waldur_api_client.api.marketplace_project_update_requests import marketplace_project_update_requests_list # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_project_update_requests_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: RemoteProjectUpdateRequestStateEnum
  2. API Source: marketplace_project_update_requests_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceProjectUpdateRequestsList } from 'waldur-js-client';

try {
  const response = await marketplaceProjectUpdateRequestsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
customer_uuid string (uuid)
offering_uuid string (uuid)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
project_uuid string (uuid)
provider_uuid string (uuid)
state array

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid)
state string
customer_name string
customer_uuid string
offering_name string
offering_uuid string (uuid)
created string (date-time)
reviewed_at string (date-time) Timestamp when the review was completed
reviewed_by_full_name string
reviewed_by_uuid string (uuid)
review_comment string Optional comment provided during review
old_name string
new_name string
old_description string
new_description string
old_end_date string (date)
new_end_date string (date)
old_oecd_fos_2007_code string
old_oecd_fos_2007_label string
new_oecd_fos_2007_code string
new_oecd_fos_2007_label string
old_is_industry boolean
new_is_industry boolean
created_by integer

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-project-update-requests/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_project_update_requests import marketplace_project_update_requests_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_project_update_requests_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_project_update_requests_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceProjectUpdateRequestsRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceProjectUpdateRequestsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
uuid string (uuid)
state string
customer_name string
customer_uuid string
offering_name string
offering_uuid string (uuid)
created string (date-time)
reviewed_at string (date-time) Timestamp when the review was completed
reviewed_by_full_name string
reviewed_by_uuid string (uuid)
review_comment string Optional comment provided during review
old_name string
new_name string
old_description string
new_description string
old_end_date string (date)
new_end_date string (date)
old_oecd_fos_2007_code string
old_oecd_fos_2007_label string
new_oecd_fos_2007_code string
new_oecd_fos_2007_label string
old_is_industry boolean
new_is_industry boolean
created_by integer

Other Actions

Approve project update request

Approve project update request

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-project-update-requests/a1b2c3d4-e5f6-7890-abcd-ef1234567890/approve/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.review_comment_request import ReviewCommentRequest # (1)
from waldur_api_client.api.marketplace_project_update_requests import marketplace_project_update_requests_approve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ReviewCommentRequest()
response = marketplace_project_update_requests_approve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ReviewCommentRequest
  2. API Source: marketplace_project_update_requests_approve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceProjectUpdateRequestsApprove } from 'waldur-js-client';

try {
  const response = await marketplaceProjectUpdateRequestsApprove({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
comment string Optional comment for review

200 - No response body

Reject project update request

Reject project update request

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-project-update-requests/a1b2c3d4-e5f6-7890-abcd-ef1234567890/reject/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.review_comment_request import ReviewCommentRequest # (1)
from waldur_api_client.api.marketplace_project_update_requests import marketplace_project_update_requests_reject # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ReviewCommentRequest()
response = marketplace_project_update_requests_reject.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ReviewCommentRequest
  2. API Source: marketplace_project_update_requests_reject
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceProjectUpdateRequestsReject } from 'waldur-js-client';

try {
  const response = await marketplaceProjectUpdateRequestsReject({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
comment string Optional comment for review

200 - No response body

Marketplace Public Api

Operations Summary

Method Endpoint Description
POST /api/marketplace-public-api/check_signature/ Check service provider signature
POST /api/marketplace-public-api/set_usage/ Set component usage with signature

Check service provider signature

1
2
3
4
5
    Validates a signed payload from a service provider. The payload is a JWT token
    signed with the provider's API secret code. This endpoint is used to verify the
    authenticity of a request before processing it.

    The `data` field should contain the JWT token.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/marketplace-public-api/check_signature/ \
  Authorization:"Token YOUR_API_TOKEN" \
  customer="a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  data="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.service_provider_signature_request import ServiceProviderSignatureRequest # (1)
from waldur_api_client.api.marketplace_public_api import marketplace_public_api_check_signature # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ServiceProviderSignatureRequest(
    customer="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    data="string-value"
)
response = marketplace_public_api_check_signature.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ServiceProviderSignatureRequest
  2. API Source: marketplace_public_api_check_signature
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { marketplacePublicApiCheckSignature } from 'waldur-js-client';

try {
  const response = await marketplacePublicApiCheckSignature({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "customer": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "data": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
customer string (uuid) ✓ Service provider customer UUID
data string ✓ JWT-encoded data signed with the service provider's API secret code
dry_run boolean If true, validates the signature without executing the operation
Constraints: default: False

200 - No response body

Set component usage with signature

1
2
3
4
5
    Allows a service provider to report usage for resource components using a signed JWT payload.
    This provides a secure way for external systems to submit billing data.

    The `data` field must contain a JWT token that, when decoded, matches the structure of the
    `ComponentUsageCreateSerializer`.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/marketplace-public-api/set_usage/ \
  Authorization:"Token YOUR_API_TOKEN" \
  customer="a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  data="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.service_provider_signature_request import ServiceProviderSignatureRequest # (1)
from waldur_api_client.api.marketplace_public_api import marketplace_public_api_set_usage # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ServiceProviderSignatureRequest(
    customer="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    data="string-value"
)
response = marketplace_public_api_set_usage.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ServiceProviderSignatureRequest
  2. API Source: marketplace_public_api_set_usage
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { marketplacePublicApiSetUsage } from 'waldur-js-client';

try {
  const response = await marketplacePublicApiSetUsage({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "customer": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "data": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
customer string (uuid) ✓ Service provider customer UUID
data string ✓ JWT-encoded data signed with the service provider's API secret code
dry_run boolean If true, validates the signature without executing the operation
Constraints: default: False

201 - No response body

Marketplace Related Customers

Method Endpoint Description
GET /api/marketplace-related-customers/{customer_uuid}/ Retrieve 
1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-related-customers/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_related_customers import marketplace_related_customers_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_related_customers_list.sync(
    customer_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

for item in response:
    print(item)
  1. API Source: marketplace_related_customers_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceRelatedCustomersList } from 'waldur-js-client';

try {
  const response = await marketplaceRelatedCustomersList({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "customer_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
customer_uuid string ✓
Name Type Description
name string Name
name_exact string Name (exact)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
uuid string (uuid)
name string

Marketplace Remote Synchronisations

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/marketplace-remote-synchronisations/ List Marketplace Remote Synchronisations
GET /api/marketplace-remote-synchronisations/{uuid}/ Retrieve
POST /api/marketplace-remote-synchronisations/ Create
PUT /api/marketplace-remote-synchronisations/{uuid}/ Update
PATCH /api/marketplace-remote-synchronisations/{uuid}/ Partial Update
DELETE /api/marketplace-remote-synchronisations/{uuid}/ Delete
Other Actions
POST /api/marketplace-remote-synchronisations/{uuid}/run_synchronisation/ Run synchronisation

Core CRUD

List Marketplace Remote Synchronisations

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-remote-synchronisations/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_remote_synchronisations import marketplace_remote_synchronisations_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_remote_synchronisations_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: marketplace_remote_synchronisations_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceRemoteSynchronisationsList } from 'waldur-js-client';

try {
  const response = await marketplaceRemoteSynchronisationsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
uuid string (uuid)
url string (uri)
api_url string (uri)
token string
remote_organization_uuid string (uuid)
remote_organization_name string
local_service_provider string (uri)
local_service_provider_name string
is_active boolean
last_execution string (date-time)
last_output string
get_state_display string
error_message string
created string (date-time)
modified string (date-time)
remotelocalcategory_set array of objects
remotelocalcategory_set.local_category string (uri)
remotelocalcategory_set.remote_category string (uuid)
remotelocalcategory_set.local_category_name string
remotelocalcategory_set.local_category_uuid string (uuid)
remotelocalcategory_set.remote_category_name string

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-remote-synchronisations/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_remote_synchronisations import marketplace_remote_synchronisations_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_remote_synchronisations_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_remote_synchronisations_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceRemoteSynchronisationsRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceRemoteSynchronisationsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
uuid string (uuid)
url string (uri)
api_url string (uri)
token string
remote_organization_uuid string (uuid)
remote_organization_name string
local_service_provider string (uri)
local_service_provider_name string
is_active boolean
last_execution string (date-time)
last_output string
get_state_display string
error_message string
created string (date-time)
modified string (date-time)
remotelocalcategory_set array of objects
remotelocalcategory_set.local_category string (uri)
remotelocalcategory_set.remote_category string (uuid)
remotelocalcategory_set.local_category_name string
remotelocalcategory_set.local_category_uuid string (uuid)
remotelocalcategory_set.remote_category_name string

Create

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
http \
  POST \
  https://api.example.com/api/marketplace-remote-synchronisations/ \
  Authorization:"Token YOUR_API_TOKEN" \
  api_url="https://api.example.com/api/api-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  token="********" \
  remote_organization_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  remote_organization_name="string-value" \
  local_service_provider="https://api.example.com/api/local-service-provider/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  remotelocalcategory_set:='[]'

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.remote_synchronisation_request import RemoteSynchronisationRequest # (1)
from waldur_api_client.api.marketplace_remote_synchronisations import marketplace_remote_synchronisations_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = RemoteSynchronisationRequest(
    api_url="https://api.example.com/api/api-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    token="********",
    remote_organization_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    remote_organization_name="string-value",
    local_service_provider="https://api.example.com/api/local-service-provider/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    remotelocalcategory_set=[]
)
response = marketplace_remote_synchronisations_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: RemoteSynchronisationRequest
  2. API Source: marketplace_remote_synchronisations_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
import { marketplaceRemoteSynchronisationsCreate } from 'waldur-js-client';

try {
  const response = await marketplaceRemoteSynchronisationsCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "api_url": "https://api.example.com/api/api-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "token": "********",
    "remote_organization_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "remote_organization_name": "string-value",
    "local_service_provider": "https://api.example.com/api/local-service-provider/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "remotelocalcategory_set": []
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required
api_url string (uri) ✓
token string ✓
remote_organization_uuid string (uuid) ✓
remote_organization_name string ✓
local_service_provider string (uri) ✓
is_active boolean
remotelocalcategory_set array of objects ✓
remotelocalcategory_set.local_category string (uri) ✓
remotelocalcategory_set.remote_category string (uuid) ✓
remotelocalcategory_set.remote_category_name string

201 -

Field Type
uuid string (uuid)
url string (uri)
api_url string (uri)
token string
remote_organization_uuid string (uuid)
remote_organization_name string
local_service_provider string (uri)
local_service_provider_name string
is_active boolean
last_execution string (date-time)
last_output string
get_state_display string
error_message string
created string (date-time)
modified string (date-time)
remotelocalcategory_set array of objects
remotelocalcategory_set.local_category string (uri)
remotelocalcategory_set.remote_category string (uuid)
remotelocalcategory_set.local_category_name string
remotelocalcategory_set.local_category_uuid string (uuid)
remotelocalcategory_set.remote_category_name string

Update

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
http \
  PUT \
  https://api.example.com/api/marketplace-remote-synchronisations/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  api_url="https://api.example.com/api/api-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  token="********" \
  remote_organization_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  remote_organization_name="string-value" \
  local_service_provider="https://api.example.com/api/local-service-provider/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  remotelocalcategory_set:='[]'

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.remote_synchronisation_request import RemoteSynchronisationRequest # (1)
from waldur_api_client.api.marketplace_remote_synchronisations import marketplace_remote_synchronisations_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = RemoteSynchronisationRequest(
    api_url="https://api.example.com/api/api-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    token="********",
    remote_organization_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    remote_organization_name="string-value",
    local_service_provider="https://api.example.com/api/local-service-provider/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    remotelocalcategory_set=[]
)
response = marketplace_remote_synchronisations_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: RemoteSynchronisationRequest
  2. API Source: marketplace_remote_synchronisations_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
import { marketplaceRemoteSynchronisationsUpdate } from 'waldur-js-client';

try {
  const response = await marketplaceRemoteSynchronisationsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "api_url": "https://api.example.com/api/api-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "token": "********",
    "remote_organization_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "remote_organization_name": "string-value",
    "local_service_provider": "https://api.example.com/api/local-service-provider/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "remotelocalcategory_set": []
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
api_url string (uri) ✓
token string ✓
remote_organization_uuid string (uuid) ✓
remote_organization_name string ✓
local_service_provider string (uri) ✓
is_active boolean
remotelocalcategory_set array of objects ✓
remotelocalcategory_set.local_category string (uri) ✓
remotelocalcategory_set.remote_category string (uuid) ✓
remotelocalcategory_set.remote_category_name string

200 -

Field Type
uuid string (uuid)
url string (uri)
api_url string (uri)
token string
remote_organization_uuid string (uuid)
remote_organization_name string
local_service_provider string (uri)
local_service_provider_name string
is_active boolean
last_execution string (date-time)
last_output string
get_state_display string
error_message string
created string (date-time)
modified string (date-time)
remotelocalcategory_set array of objects
remotelocalcategory_set.local_category string (uri)
remotelocalcategory_set.remote_category string (uuid)
remotelocalcategory_set.local_category_name string
remotelocalcategory_set.local_category_uuid string (uuid)
remotelocalcategory_set.remote_category_name string

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/marketplace-remote-synchronisations/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_remote_synchronisation_request import PatchedRemoteSynchronisationRequest # (1)
from waldur_api_client.api.marketplace_remote_synchronisations import marketplace_remote_synchronisations_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedRemoteSynchronisationRequest()
response = marketplace_remote_synchronisations_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedRemoteSynchronisationRequest
  2. API Source: marketplace_remote_synchronisations_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceRemoteSynchronisationsPartialUpdate } from 'waldur-js-client';

try {
  const response = await marketplaceRemoteSynchronisationsPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
api_url string (uri)
token string
remote_organization_name string
local_service_provider string (uri)
is_active boolean
remotelocalcategory_set array of objects
remotelocalcategory_set.local_category string (uri) ✓
remotelocalcategory_set.remote_category string (uuid) ✓
remotelocalcategory_set.remote_category_name string

200 -

Field Type
uuid string (uuid)
url string (uri)
api_url string (uri)
token string
remote_organization_uuid string (uuid)
remote_organization_name string
local_service_provider string (uri)
local_service_provider_name string
is_active boolean
last_execution string (date-time)
last_output string
get_state_display string
error_message string
created string (date-time)
modified string (date-time)
remotelocalcategory_set array of objects
remotelocalcategory_set.local_category string (uri)
remotelocalcategory_set.remote_category string (uuid)
remotelocalcategory_set.local_category_name string
remotelocalcategory_set.local_category_uuid string (uuid)
remotelocalcategory_set.remote_category_name string

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/marketplace-remote-synchronisations/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_remote_synchronisations import marketplace_remote_synchronisations_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_remote_synchronisations_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_remote_synchronisations_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceRemoteSynchronisationsDestroy } from 'waldur-js-client';

try {
  const response = await marketplaceRemoteSynchronisationsDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Other Actions

Run synchronisation

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-remote-synchronisations/a1b2c3d4-e5f6-7890-abcd-ef1234567890/run_synchronisation/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_remote_synchronisations import marketplace_remote_synchronisations_run_synchronisation # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_remote_synchronisations_run_synchronisation.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_remote_synchronisations_run_synchronisation
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceRemoteSynchronisationsRunSynchronisation } from 'waldur-js-client';

try {
  const response = await marketplaceRemoteSynchronisationsRunSynchronisation({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
uuid string (uuid)
url string (uri)
api_url string (uri)
token string
remote_organization_uuid string (uuid)
remote_organization_name string
local_service_provider string (uri)
local_service_provider_name string
is_active boolean
last_execution string (date-time)
last_output string
get_state_display string
error_message string
created string (date-time)
modified string (date-time)
remotelocalcategory_set array of objects
remotelocalcategory_set.local_category string (uri)
remotelocalcategory_set.remote_category string (uuid)
remotelocalcategory_set.local_category_name string
remotelocalcategory_set.local_category_uuid string (uuid)
remotelocalcategory_set.remote_category_name string

Remote Waldur Api

Operations Summary

Method Endpoint Description
Core CRUD
POST /api/remote-waldur-api/pull_offering_details/{uuid}/ Details
POST /api/remote-waldur-api/pull_offering_invoices/{uuid}/ Invoices
POST /api/remote-waldur-api/pull_offering_orders/{uuid}/ Orders
POST /api/remote-waldur-api/pull_offering_resources/{uuid}/ Resources
POST /api/remote-waldur-api/pull_offering_robot_accounts/{uuid}/ Accounts
POST /api/remote-waldur-api/pull_offering_usage/{uuid}/ Usage
POST /api/remote-waldur-api/pull_offering_users/{uuid}/ Users
POST /api/remote-waldur-api/pull_order/{uuid} Schedule order pull task
POST /api/remote-waldur-api/pull_resource_robot_accounts/{uuid}/ Accounts
Other Actions
GET /api/remote-waldur-api/remote_resource_order_status/{resource_uuid}/ Get remote order details
GET /api/remote-waldur-api/remote_resource_status/{resource_uuid}/ Get remote resource sync status
GET /api/remote-waldur-api/remote_resource_team_status/{resource_uuid}/ Get remote resource team members
POST /api/remote-waldur-api/cancel_termination/{uuid} Cancel termination order
POST /api/remote-waldur-api/import_offering/ Create local offering from remote
POST /api/remote-waldur-api/push_project_data/{uuid}/ Data
POST /api/remote-waldur-api/remote_categories/ List remote marketplace categories
POST /api/remote-waldur-api/remote_customers/ List remote customers owned by current user
POST /api/remote-waldur-api/shared_offerings/ List remote importable offerings for particular customer
POST /api/remote-waldur-api/sync_resource/{uuid}/ Resource
POST /api/remote-waldur-api/sync_resource_project_permissions/{uuid}/ Permissions

Core CRUD

Details

1
2
3
4
http \
  POST \
  https://api.example.com/api/remote-waldur-api/pull_offering_details/string-value/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.remote_waldur_api import remote_waldur_api_pull_offering_details # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = remote_waldur_api_pull_offering_details.sync(
    uuid="string-value",
    client=client
)

print(response)
  1. API Source: remote_waldur_api_pull_offering_details
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { remoteWaldurApiPullOfferingDetails } from 'waldur-js-client';

try {
  const response = await remoteWaldurApiPullOfferingDetails({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string ✓

200 - No response body

Invoices

1
2
3
4
http \
  POST \
  https://api.example.com/api/remote-waldur-api/pull_offering_invoices/string-value/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.remote_waldur_api import remote_waldur_api_pull_offering_invoices # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = remote_waldur_api_pull_offering_invoices.sync(
    uuid="string-value",
    client=client
)

print(response)
  1. API Source: remote_waldur_api_pull_offering_invoices
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { remoteWaldurApiPullOfferingInvoices } from 'waldur-js-client';

try {
  const response = await remoteWaldurApiPullOfferingInvoices({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string ✓

200 - No response body

Orders

1
2
3
4
http \
  POST \
  https://api.example.com/api/remote-waldur-api/pull_offering_orders/string-value/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.remote_waldur_api import remote_waldur_api_pull_offering_orders # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = remote_waldur_api_pull_offering_orders.sync(
    uuid="string-value",
    client=client
)

print(response)
  1. API Source: remote_waldur_api_pull_offering_orders
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { remoteWaldurApiPullOfferingOrders } from 'waldur-js-client';

try {
  const response = await remoteWaldurApiPullOfferingOrders({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string ✓

200 - No response body

Resources

1
2
3
4
http \
  POST \
  https://api.example.com/api/remote-waldur-api/pull_offering_resources/string-value/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.remote_waldur_api import remote_waldur_api_pull_offering_resources # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = remote_waldur_api_pull_offering_resources.sync(
    uuid="string-value",
    client=client
)

print(response)
  1. API Source: remote_waldur_api_pull_offering_resources
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { remoteWaldurApiPullOfferingResources } from 'waldur-js-client';

try {
  const response = await remoteWaldurApiPullOfferingResources({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string ✓

200 - No response body

Accounts

1
2
3
4
http \
  POST \
  https://api.example.com/api/remote-waldur-api/pull_offering_robot_accounts/string-value/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.remote_waldur_api import remote_waldur_api_pull_offering_robot_accounts # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = remote_waldur_api_pull_offering_robot_accounts.sync(
    uuid="string-value",
    client=client
)

print(response)
  1. API Source: remote_waldur_api_pull_offering_robot_accounts
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { remoteWaldurApiPullOfferingRobotAccounts } from 'waldur-js-client';

try {
  const response = await remoteWaldurApiPullOfferingRobotAccounts({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string ✓

200 - No response body

Usage

1
2
3
4
http \
  POST \
  https://api.example.com/api/remote-waldur-api/pull_offering_usage/string-value/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.remote_waldur_api import remote_waldur_api_pull_offering_usage # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = remote_waldur_api_pull_offering_usage.sync(
    uuid="string-value",
    client=client
)

print(response)
  1. API Source: remote_waldur_api_pull_offering_usage
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { remoteWaldurApiPullOfferingUsage } from 'waldur-js-client';

try {
  const response = await remoteWaldurApiPullOfferingUsage({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string ✓

200 - No response body

Users

1
2
3
4
http \
  POST \
  https://api.example.com/api/remote-waldur-api/pull_offering_users/string-value/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.remote_waldur_api import remote_waldur_api_pull_offering_users # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = remote_waldur_api_pull_offering_users.sync(
    uuid="string-value",
    client=client
)

print(response)
  1. API Source: remote_waldur_api_pull_offering_users
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { remoteWaldurApiPullOfferingUsers } from 'waldur-js-client';

try {
  const response = await remoteWaldurApiPullOfferingUsers({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string ✓

200 - No response body

Schedule order pull task

Schedule order pull task

1
2
3
4
http \
  POST \
  https://api.example.com/api/remote-waldur-api/pull_order/string-value \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.remote_waldur_api import remote_waldur_api_pull_order # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = remote_waldur_api_pull_order.sync(
    uuid="string-value",
    client=client
)

print(response)
  1. API Source: remote_waldur_api_pull_order
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { remoteWaldurApiPullOrder } from 'waldur-js-client';

try {
  const response = await remoteWaldurApiPullOrder({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string ✓

200 - No response body

Accounts

1
2
3
4
http \
  POST \
  https://api.example.com/api/remote-waldur-api/pull_resource_robot_accounts/string-value/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.remote_waldur_api import remote_waldur_api_pull_resource_robot_accounts # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = remote_waldur_api_pull_resource_robot_accounts.sync(
    uuid="string-value",
    client=client
)

print(response)
  1. API Source: remote_waldur_api_pull_resource_robot_accounts
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { remoteWaldurApiPullResourceRobotAccounts } from 'waldur-js-client';

try {
  const response = await remoteWaldurApiPullResourceRobotAccounts({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string ✓

200 - No response body

Other Actions

Get remote order details

Get remote order details

1
2
3
4
http \
  GET \
  https://api.example.com/api/remote-waldur-api/remote_resource_order_status/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.remote_waldur_api import remote_waldur_api_remote_resource_order_status_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = remote_waldur_api_remote_resource_order_status_retrieve.sync(
    resource_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: remote_waldur_api_remote_resource_order_status_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { remoteWaldurApiRemoteResourceOrderStatusRetrieve } from 'waldur-js-client';

try {
  const response = await remoteWaldurApiRemoteResourceOrderStatusRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "resource_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
resource_uuid string ✓

200 -

Field Type Description
order_uuid string (uuid) Order UUID
remote_state any Remote order state
local_state any Local order state
sync_status any Sync status: in_sync, out_of_sync, sync_failed

Get remote resource sync status

Get remote resource sync status

1
2
3
4
http \
  GET \
  https://api.example.com/api/remote-waldur-api/remote_resource_status/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.remote_waldur_api import remote_waldur_api_remote_resource_status_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = remote_waldur_api_remote_resource_status_retrieve.sync(
    resource_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: remote_waldur_api_remote_resource_status_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { remoteWaldurApiRemoteResourceStatusRetrieve } from 'waldur-js-client';

try {
  const response = await remoteWaldurApiRemoteResourceStatusRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "resource_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
resource_uuid string ✓

200 -

Field Type Description
local_state any Local resource state
remote_state any Remote resource state
sync_status any Sync status: in_sync, out_of_sync, sync_failed
last_sync string (date-time) Last sync timestamp

Get remote resource team members

Get remote resource team members

1
2
3
4
http \
  GET \
  https://api.example.com/api/remote-waldur-api/remote_resource_team_status/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.remote_waldur_api import remote_waldur_api_remote_resource_team_status_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = remote_waldur_api_remote_resource_team_status_list.sync(
    resource_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

for item in response:
    print(item)
  1. API Source: remote_waldur_api_remote_resource_team_status_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { remoteWaldurApiRemoteResourceTeamStatusList } from 'waldur-js-client';

try {
  const response = await remoteWaldurApiRemoteResourceTeamStatusList({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "resource_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
resource_uuid string ✓
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
full_name string Full name
local_role string Local role
remote_role string Remote role
sync_status any Sync status: in_sync, out_of_sync, sync_failed

Cancel termination order

Cancel termination order

1
2
3
4
http \
  POST \
  https://api.example.com/api/remote-waldur-api/cancel_termination/string-value \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.remote_waldur_api import remote_waldur_api_cancel_termination # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = remote_waldur_api_cancel_termination.sync(
    uuid="string-value",
    client=client
)

print(response)
  1. API Source: remote_waldur_api_cancel_termination
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { remoteWaldurApiCancelTermination } from 'waldur-js-client';

try {
  const response = await remoteWaldurApiCancelTermination({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string ✓

200 - No response body

Create local offering from remote

Create local offering from remote

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
http \
  POST \
  https://api.example.com/api/remote-waldur-api/import_offering/ \
  Authorization:"Token YOUR_API_TOKEN" \
  api_url="https://api.example.com/api/api-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  token="********" \
  remote_offering_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  local_category_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  local_customer_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  remote_customer_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.remote_offering_create_request import RemoteOfferingCreateRequest # (1)
from waldur_api_client.api.remote_waldur_api import remote_waldur_api_import_offering # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = RemoteOfferingCreateRequest(
    api_url="https://api.example.com/api/api-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    token="********",
    remote_offering_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    local_category_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    local_customer_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    remote_customer_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
)
response = remote_waldur_api_import_offering.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: RemoteOfferingCreateRequest
  2. API Source: remote_waldur_api_import_offering
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
import { remoteWaldurApiImportOffering } from 'waldur-js-client';

try {
  const response = await remoteWaldurApiImportOffering({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "api_url": "https://api.example.com/api/api-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "token": "********",
    "remote_offering_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "local_category_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "local_customer_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "remote_customer_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required
api_url string (uri) ✓
token string ✓
remote_offering_uuid string (uuid) ✓
local_category_uuid string (uuid) ✓
local_customer_uuid string (uuid) ✓
remote_customer_uuid string (uuid) ✓

200 -

Field Type
uuid string (uuid)

Data

1
2
3
4
http \
  POST \
  https://api.example.com/api/remote-waldur-api/push_project_data/string-value/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.remote_waldur_api import remote_waldur_api_push_project_data # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = remote_waldur_api_push_project_data.sync(
    uuid="string-value",
    client=client
)

print(response)
  1. API Source: remote_waldur_api_push_project_data
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { remoteWaldurApiPushProjectData } from 'waldur-js-client';

try {
  const response = await remoteWaldurApiPushProjectData({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string ✓

200 - No response body

List remote marketplace categories

List remote marketplace categories

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/remote-waldur-api/remote_categories/ \
  Authorization:"Token YOUR_API_TOKEN" \
  api_url="https://api.example.com/api/api-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  token="********"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.remote_credentials_request import RemoteCredentialsRequest # (1)
from waldur_api_client.api.remote_waldur_api import remote_waldur_api_remote_categories # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = RemoteCredentialsRequest(
    api_url="https://api.example.com/api/api-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    token="********"
)
response = remote_waldur_api_remote_categories.sync(
    client=client,
    body=body_data
)

for item in response:
    print(item)
  1. Model Source: RemoteCredentialsRequest
  2. API Source: remote_waldur_api_remote_categories
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { remoteWaldurApiRemoteCategories } from 'waldur-js-client';

try {
  const response = await remoteWaldurApiRemoteCategories({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "api_url": "https://api.example.com/api/api-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "token": "********"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
Field Type Required
api_url string (uri) ✓
token string ✓

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
title string
description string
icon string (uri)
default_vm_category boolean Set to "true" if this category is for OpenStack VM. Only one category can have "true" value.
default_volume_category boolean Set to true if this category is for OpenStack Volume. Only one category can have "true" value.
default_tenant_category boolean Set to true if this category is for OpenStack Tenant. Only one category can have "true" value.
offering_count integer
available_offerings_count integer
sections array of objects
sections.key string
sections.title string
sections.attributes array of objects
sections.attributes.key string
sections.attributes.title string
sections.attributes.type string
Enum: boolean, string, text, integer, choice, list
sections.attributes.options array of objects
sections.attributes.options.key string
sections.attributes.options.title string
sections.attributes.required boolean A value must be provided for the attribute.
sections.attributes.default any
sections.is_standalone boolean Whether section is rendered as a separate tab.
columns array of objects
columns.uuid string (uuid)
columns.index integer Index allows to reorder columns.
columns.title string Title is rendered as column header.
columns.attribute string Resource attribute is rendered as table cell.
columns.widget any Widget field allows to customise table cell rendering.
components array of objects
components.type string Unique internal name of the measured unit, for example floating_ip.
components.name string Display name for the measured unit, for example, Floating IP.
components.description string
components.measured_unit string Unit of measurement, for example, GB.
articles array of objects
articles.title string
articles.url string (uri)
group string (uri)

List remote customers owned by current user

List remote customers owned by current user

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/remote-waldur-api/remote_customers/ \
  Authorization:"Token YOUR_API_TOKEN" \
  api_url="https://api.example.com/api/api-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  token="********"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.remote_credentials_request import RemoteCredentialsRequest # (1)
from waldur_api_client.api.remote_waldur_api import remote_waldur_api_remote_customers # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = RemoteCredentialsRequest(
    api_url="https://api.example.com/api/api-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    token="********"
)
response = remote_waldur_api_remote_customers.sync(
    client=client,
    body=body_data
)

for item in response:
    print(item)
  1. Model Source: RemoteCredentialsRequest
  2. API Source: remote_waldur_api_remote_customers
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { remoteWaldurApiRemoteCustomers } from 'waldur-js-client';

try {
  const response = await remoteWaldurApiRemoteCustomers({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "api_url": "https://api.example.com/api/api-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "token": "********"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
Field Type Required
api_url string (uri) ✓
token string ✓

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
uuid string (uuid)
name string
abbreviation string
phone_number string
email string

List remote importable offerings for particular customer

List remote importable offerings for particular customer

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/remote-waldur-api/shared_offerings/ \
  Authorization:"Token YOUR_API_TOKEN" \
  api_url="https://api.example.com/api/api-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  token="********"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.remote_credentials_request import RemoteCredentialsRequest # (1)
from waldur_api_client.api.remote_waldur_api import remote_waldur_api_shared_offerings # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = RemoteCredentialsRequest(
    api_url="https://api.example.com/api/api-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    token="********"
)
response = remote_waldur_api_shared_offerings.sync(
    client=client,
    body=body_data
)

for item in response:
    print(item)
  1. Model Source: RemoteCredentialsRequest
  2. API Source: remote_waldur_api_shared_offerings
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { remoteWaldurApiSharedOfferings } from 'waldur-js-client';

try {
  const response = await remoteWaldurApiSharedOfferings({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "api_url": "https://api.example.com/api/api-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "token": "********"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
customer_uuid string
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
Field Type Required
api_url string (uri) ✓
token string ✓

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
uuid string (uuid)
name string
type string
state string
category_title string

Resource

1
2
3
4
http \
  POST \
  https://api.example.com/api/remote-waldur-api/sync_resource/string-value/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.remote_waldur_api import remote_waldur_api_sync_resource # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = remote_waldur_api_sync_resource.sync(
    uuid="string-value",
    client=client
)

print(response)
  1. API Source: remote_waldur_api_sync_resource
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { remoteWaldurApiSyncResource } from 'waldur-js-client';

try {
  const response = await remoteWaldurApiSyncResource({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string ✓

200 - No response body

Permissions

1
2
3
4
http \
  POST \
  https://api.example.com/api/remote-waldur-api/sync_resource_project_permissions/string-value/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.remote_waldur_api import remote_waldur_api_sync_resource_project_permissions # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = remote_waldur_api_sync_resource_project_permissions.sync(
    uuid="string-value",
    client=client
)

print(response)
  1. API Source: remote_waldur_api_sync_resource_project_permissions
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { remoteWaldurApiSyncResourceProjectPermissions } from 'waldur-js-client';

try {
  const response = await remoteWaldurApiSyncResourceProjectPermissions({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string ✓

200 - No response body

Maintenance

Maintenance Announcement Offerings

Operations Summary

Method Endpoint Description
GET /api/maintenance-announcement-offerings/ List affected offerings for maintenance
GET /api/maintenance-announcement-offerings/{uuid}/ Retrieve an affected offering link
POST /api/maintenance-announcement-offerings/ Link an offering to a maintenance announcement
PUT /api/maintenance-announcement-offerings/{uuid}/ Update an affected offering link
PATCH /api/maintenance-announcement-offerings/{uuid}/ Partially update an affected offering link
DELETE /api/maintenance-announcement-offerings/{uuid}/ Unlink an offering from a maintenance announcement

List affected offerings for maintenance

Returns a paginated list of offerings affected by maintenance announcements.

1
2
3
4
http \
  GET \
  https://api.example.com/api/maintenance-announcement-offerings/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.maintenance_announcement_offerings import maintenance_announcement_offerings_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = maintenance_announcement_offerings_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: maintenance_announcement_offerings_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { maintenanceAnnouncementOfferingsList } from 'waldur-js-client';

try {
  const response = await maintenanceAnnouncementOfferingsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
maintenance string (uri)
offering string (uri)
impact_level any Expected impact on this offering
impact_level_display any
impact_description string Specific description of how this offering will be affected
offering_name string

Returns the details of a specific link between a maintenance announcement and an offering, including the impact level and description.

1
2
3
4
http \
  GET \
  https://api.example.com/api/maintenance-announcement-offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.maintenance_announcement_offerings import maintenance_announcement_offerings_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = maintenance_announcement_offerings_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: maintenance_announcement_offerings_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { maintenanceAnnouncementOfferingsRetrieve } from 'waldur-js-client';

try {
  const response = await maintenanceAnnouncementOfferingsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
url string (uri)
uuid string (uuid)
maintenance string (uri)
offering string (uri)
impact_level any Expected impact on this offering
impact_level_display any
impact_description string Specific description of how this offering will be affected
offering_name string

Creates a new association between an offering and a maintenance announcement, specifying the expected impact.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/maintenance-announcement-offerings/ \
  Authorization:"Token YOUR_API_TOKEN" \
  maintenance="https://api.example.com/api/maintenance/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  offering="https://api.example.com/api/offering/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.maintenance_announcement_offering_request import MaintenanceAnnouncementOfferingRequest # (1)
from waldur_api_client.api.maintenance_announcement_offerings import maintenance_announcement_offerings_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = MaintenanceAnnouncementOfferingRequest(
    maintenance="https://api.example.com/api/maintenance/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    offering="https://api.example.com/api/offering/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = maintenance_announcement_offerings_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: MaintenanceAnnouncementOfferingRequest
  2. API Source: maintenance_announcement_offerings_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { maintenanceAnnouncementOfferingsCreate } from 'waldur-js-client';

try {
  const response = await maintenanceAnnouncementOfferingsCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "maintenance": "https://api.example.com/api/maintenance/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "offering": "https://api.example.com/api/offering/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
maintenance string (uri) ✓
offering string (uri) ✓
impact_level any Expected impact on this offering
impact_description string Specific description of how this offering will be affected

201 -

Field Type Description
url string (uri)
uuid string (uuid)
maintenance string (uri)
offering string (uri)
impact_level any Expected impact on this offering
impact_level_display any
impact_description string Specific description of how this offering will be affected
offering_name string

Updates the impact level or description for an offering linked to a maintenance announcement.

1
2
3
4
5
6
http \
  PUT \
  https://api.example.com/api/maintenance-announcement-offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  maintenance="https://api.example.com/api/maintenance/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  offering="https://api.example.com/api/offering/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.maintenance_announcement_offering_request import MaintenanceAnnouncementOfferingRequest # (1)
from waldur_api_client.api.maintenance_announcement_offerings import maintenance_announcement_offerings_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = MaintenanceAnnouncementOfferingRequest(
    maintenance="https://api.example.com/api/maintenance/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    offering="https://api.example.com/api/offering/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = maintenance_announcement_offerings_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: MaintenanceAnnouncementOfferingRequest
  2. API Source: maintenance_announcement_offerings_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { maintenanceAnnouncementOfferingsUpdate } from 'waldur-js-client';

try {
  const response = await maintenanceAnnouncementOfferingsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "maintenance": "https://api.example.com/api/maintenance/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "offering": "https://api.example.com/api/offering/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
maintenance string (uri) ✓
offering string (uri) ✓
impact_level any Expected impact on this offering
impact_description string Specific description of how this offering will be affected

200 -

Field Type Description
url string (uri)
uuid string (uuid)
maintenance string (uri)
offering string (uri)
impact_level any Expected impact on this offering
impact_level_display any
impact_description string Specific description of how this offering will be affected
offering_name string

Partially updates the impact level or description for an offering linked to a maintenance announcement.

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/maintenance-announcement-offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_maintenance_announcement_offering_request import PatchedMaintenanceAnnouncementOfferingRequest # (1)
from waldur_api_client.api.maintenance_announcement_offerings import maintenance_announcement_offerings_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedMaintenanceAnnouncementOfferingRequest()
response = maintenance_announcement_offerings_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedMaintenanceAnnouncementOfferingRequest
  2. API Source: maintenance_announcement_offerings_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { maintenanceAnnouncementOfferingsPartialUpdate } from 'waldur-js-client';

try {
  const response = await maintenanceAnnouncementOfferingsPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
maintenance string (uri)
offering string (uri)
impact_level any Expected impact on this offering
impact_description string Specific description of how this offering will be affected

200 -

Field Type Description
url string (uri)
uuid string (uuid)
maintenance string (uri)
offering string (uri)
impact_level any Expected impact on this offering
impact_level_display any
impact_description string Specific description of how this offering will be affected
offering_name string

Removes the association between an offering and a maintenance announcement.

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/maintenance-announcement-offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.maintenance_announcement_offerings import maintenance_announcement_offerings_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = maintenance_announcement_offerings_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: maintenance_announcement_offerings_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { maintenanceAnnouncementOfferingsDestroy } from 'waldur-js-client';

try {
  const response = await maintenanceAnnouncementOfferingsDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Maintenance Announcement Template Offerings

Operations Summary

Method Endpoint Description
GET /api/maintenance-announcement-template-offerings/ List affected offering templates
GET /api/maintenance-announcement-template-offerings/{uuid}/ Retrieve an affected offering template link
POST /api/maintenance-announcement-template-offerings/ Link an offering to a maintenance template
PUT /api/maintenance-announcement-template-offerings/{uuid}/ Update an affected offering template link
PATCH /api/maintenance-announcement-template-offerings/{uuid}/ Partially update an affected offering template link
DELETE /api/maintenance-announcement-template-offerings/{uuid}/ Unlink an offering from a maintenance template

List affected offering templates

Returns a paginated list of associations between maintenance announcement templates and offerings.

1
2
3
4
http \
  GET \
  https://api.example.com/api/maintenance-announcement-template-offerings/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.backend_resource_req_o_enum import BackendResourceReqOEnum # (1)
from waldur_api_client.api.maintenance_announcement_template_offerings import maintenance_announcement_template_offerings_list # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = maintenance_announcement_template_offerings_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: BackendResourceReqOEnum
  2. API Source: maintenance_announcement_template_offerings_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { maintenanceAnnouncementTemplateOfferingsList } from 'waldur-js-client';

try {
  const response = await maintenanceAnnouncementTemplateOfferingsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
impact_level integer Impact level
maintenance_template_uuid string (uuid) Maintenance template UUID
o array Ordering
offering_uuid string (uuid) Offering UUID
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
service_provider_uuid string (uuid) Service provider UUID

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
maintenance_template string (uri)
offering string (uri)
offering_name string
offering_uuid string (uuid)
impact_level any Expected impact on this offering
impact_description string Specific description of how this offering will be affected

Returns the details of a specific link between a maintenance announcement template and an offering.

1
2
3
4
http \
  GET \
  https://api.example.com/api/maintenance-announcement-template-offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.maintenance_announcement_template_offerings import maintenance_announcement_template_offerings_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = maintenance_announcement_template_offerings_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: maintenance_announcement_template_offerings_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { maintenanceAnnouncementTemplateOfferingsRetrieve } from 'waldur-js-client';

try {
  const response = await maintenanceAnnouncementTemplateOfferingsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
url string (uri)
uuid string (uuid)
maintenance_template string (uri)
offering string (uri)
offering_name string
offering_uuid string (uuid)
impact_level any Expected impact on this offering
impact_description string Specific description of how this offering will be affected

Creates a reusable association between an offering and a maintenance announcement template, specifying a default impact level and description.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/maintenance-announcement-template-offerings/ \
  Authorization:"Token YOUR_API_TOKEN" \
  maintenance_template="https://api.example.com/api/maintenance-template/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  offering="https://api.example.com/api/offering/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.maintenance_announcement_offering_template_request import MaintenanceAnnouncementOfferingTemplateRequest # (1)
from waldur_api_client.api.maintenance_announcement_template_offerings import maintenance_announcement_template_offerings_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = MaintenanceAnnouncementOfferingTemplateRequest(
    maintenance_template="https://api.example.com/api/maintenance-template/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    offering="https://api.example.com/api/offering/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = maintenance_announcement_template_offerings_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: MaintenanceAnnouncementOfferingTemplateRequest
  2. API Source: maintenance_announcement_template_offerings_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { maintenanceAnnouncementTemplateOfferingsCreate } from 'waldur-js-client';

try {
  const response = await maintenanceAnnouncementTemplateOfferingsCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "maintenance_template": "https://api.example.com/api/maintenance-template/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "offering": "https://api.example.com/api/offering/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
maintenance_template string (uri) ✓
offering string (uri) ✓
impact_level any Expected impact on this offering
impact_description string Specific description of how this offering will be affected

201 -

Field Type Description
url string (uri)
uuid string (uuid)
maintenance_template string (uri)
offering string (uri)
offering_name string
offering_uuid string (uuid)
impact_level any Expected impact on this offering
impact_description string Specific description of how this offering will be affected

Updates the default impact level or description for an offering linked to a maintenance template.

1
2
3
4
5
6
http \
  PUT \
  https://api.example.com/api/maintenance-announcement-template-offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  maintenance_template="https://api.example.com/api/maintenance-template/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  offering="https://api.example.com/api/offering/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.maintenance_announcement_offering_template_request import MaintenanceAnnouncementOfferingTemplateRequest # (1)
from waldur_api_client.api.maintenance_announcement_template_offerings import maintenance_announcement_template_offerings_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = MaintenanceAnnouncementOfferingTemplateRequest(
    maintenance_template="https://api.example.com/api/maintenance-template/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    offering="https://api.example.com/api/offering/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = maintenance_announcement_template_offerings_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: MaintenanceAnnouncementOfferingTemplateRequest
  2. API Source: maintenance_announcement_template_offerings_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { maintenanceAnnouncementTemplateOfferingsUpdate } from 'waldur-js-client';

try {
  const response = await maintenanceAnnouncementTemplateOfferingsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "maintenance_template": "https://api.example.com/api/maintenance-template/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "offering": "https://api.example.com/api/offering/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
maintenance_template string (uri) ✓
offering string (uri) ✓
impact_level any Expected impact on this offering
impact_description string Specific description of how this offering will be affected

200 -

Field Type Description
url string (uri)
uuid string (uuid)
maintenance_template string (uri)
offering string (uri)
offering_name string
offering_uuid string (uuid)
impact_level any Expected impact on this offering
impact_description string Specific description of how this offering will be affected

Partially updates the default impact level or description for an offering linked to a maintenance template.

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/maintenance-announcement-template-offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_maintenance_announcement_offering_template_request import PatchedMaintenanceAnnouncementOfferingTemplateRequest # (1)
from waldur_api_client.api.maintenance_announcement_template_offerings import maintenance_announcement_template_offerings_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedMaintenanceAnnouncementOfferingTemplateRequest()
response = maintenance_announcement_template_offerings_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedMaintenanceAnnouncementOfferingTemplateRequest
  2. API Source: maintenance_announcement_template_offerings_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { maintenanceAnnouncementTemplateOfferingsPartialUpdate } from 'waldur-js-client';

try {
  const response = await maintenanceAnnouncementTemplateOfferingsPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
maintenance_template string (uri)
offering string (uri)
impact_level any Expected impact on this offering
impact_description string Specific description of how this offering will be affected

200 -

Field Type Description
url string (uri)
uuid string (uuid)
maintenance_template string (uri)
offering string (uri)
offering_name string
offering_uuid string (uuid)
impact_level any Expected impact on this offering
impact_description string Specific description of how this offering will be affected

Removes the association between an offering and a maintenance announcement template.

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/maintenance-announcement-template-offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.maintenance_announcement_template_offerings import maintenance_announcement_template_offerings_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = maintenance_announcement_template_offerings_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: maintenance_announcement_template_offerings_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { maintenanceAnnouncementTemplateOfferingsDestroy } from 'waldur-js-client';

try {
  const response = await maintenanceAnnouncementTemplateOfferingsDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Maintenance Announcements Template

Operations Summary

Method Endpoint Description
GET /api/maintenance-announcements-template/ List maintenance announcement templates
GET /api/maintenance-announcements-template/{uuid}/ Retrieve a maintenance announcement template
POST /api/maintenance-announcements-template/ Create a maintenance announcement template
PUT /api/maintenance-announcements-template/{uuid}/ Update a maintenance announcement template
PATCH /api/maintenance-announcements-template/{uuid}/ Partially update a maintenance announcement template
DELETE /api/maintenance-announcements-template/{uuid}/ Delete a maintenance announcement template

List maintenance announcement templates

Returns a paginated list of reusable templates for maintenance announcements.

1
2
3
4
http \
  GET \
  https://api.example.com/api/maintenance-announcements-template/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.maintenance_announcement_template_o_enum import MaintenanceAnnouncementTemplateOEnum # (1)
from waldur_api_client.api.maintenance_announcements_template import maintenance_announcements_template_list # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = maintenance_announcements_template_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: MaintenanceAnnouncementTemplateOEnum
  2. API Source: maintenance_announcements_template_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { maintenanceAnnouncementsTemplateList } from 'waldur-js-client';

try {
  const response = await maintenanceAnnouncementsTemplateList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
maintenance_type integer Maintenance type
o array Ordering
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
service_provider_uuid string (uuid) Service provider UUID

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
name string
message string
maintenance_type any Type of maintenance being performed
service_provider string (uri) Service provider announcing the maintenance
affected_offerings array of objects
affected_offerings.url string (uri)
affected_offerings.uuid string (uuid)
affected_offerings.maintenance string (uri)
affected_offerings.offering string (uri)
affected_offerings.impact_level any Expected impact on this offering
affected_offerings.impact_level_display any
affected_offerings.impact_description string Specific description of how this offering will be affected
affected_offerings.offering_name string

Retrieve a maintenance announcement template

Returns the details of a specific maintenance announcement template.

1
2
3
4
http \
  GET \
  https://api.example.com/api/maintenance-announcements-template/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.maintenance_announcements_template import maintenance_announcements_template_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = maintenance_announcements_template_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: maintenance_announcements_template_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { maintenanceAnnouncementsTemplateRetrieve } from 'waldur-js-client';

try {
  const response = await maintenanceAnnouncementsTemplateRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
message string
maintenance_type any Type of maintenance being performed
service_provider string (uri) Service provider announcing the maintenance
affected_offerings array of objects
affected_offerings.url string (uri)
affected_offerings.uuid string (uuid)
affected_offerings.maintenance string (uri)
affected_offerings.offering string (uri)
affected_offerings.impact_level any Expected impact on this offering
affected_offerings.impact_level_display any
affected_offerings.impact_description string Specific description of how this offering will be affected
affected_offerings.offering_name string

Create a maintenance announcement template

Creates a new reusable template for maintenance announcements, including a default message and type.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/maintenance-announcements-template/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-maintenance-announcements-template" \
  service_provider="https://api.example.com/api/service-provider/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.maintenance_announcement_template_request import MaintenanceAnnouncementTemplateRequest # (1)
from waldur_api_client.api.maintenance_announcements_template import maintenance_announcements_template_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = MaintenanceAnnouncementTemplateRequest(
    name="my-awesome-maintenance-announcements-template",
    service_provider="https://api.example.com/api/service-provider/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = maintenance_announcements_template_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: MaintenanceAnnouncementTemplateRequest
  2. API Source: maintenance_announcements_template_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { maintenanceAnnouncementsTemplateCreate } from 'waldur-js-client';

try {
  const response = await maintenanceAnnouncementsTemplateCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "name": "my-awesome-maintenance-announcements-template",
    "service_provider": "https://api.example.com/api/service-provider/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
name string ✓
message string
maintenance_type any Type of maintenance being performed
service_provider string (uri) ✓ Service provider announcing the maintenance

201 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
message string
maintenance_type any Type of maintenance being performed
service_provider string (uri) Service provider announcing the maintenance
affected_offerings array of objects
affected_offerings.url string (uri)
affected_offerings.uuid string (uuid)
affected_offerings.maintenance string (uri)
affected_offerings.offering string (uri)
affected_offerings.impact_level any Expected impact on this offering
affected_offerings.impact_level_display any
affected_offerings.impact_description string Specific description of how this offering will be affected
affected_offerings.offering_name string

Update a maintenance announcement template

Updates an existing maintenance announcement template.

1
2
3
4
5
6
http \
  PUT \
  https://api.example.com/api/maintenance-announcements-template/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-maintenance-announcements-template" \
  service_provider="https://api.example.com/api/service-provider/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.maintenance_announcement_template_request import MaintenanceAnnouncementTemplateRequest # (1)
from waldur_api_client.api.maintenance_announcements_template import maintenance_announcements_template_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = MaintenanceAnnouncementTemplateRequest(
    name="my-awesome-maintenance-announcements-template",
    service_provider="https://api.example.com/api/service-provider/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = maintenance_announcements_template_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: MaintenanceAnnouncementTemplateRequest
  2. API Source: maintenance_announcements_template_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { maintenanceAnnouncementsTemplateUpdate } from 'waldur-js-client';

try {
  const response = await maintenanceAnnouncementsTemplateUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-maintenance-announcements-template",
    "service_provider": "https://api.example.com/api/service-provider/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
name string ✓
message string
maintenance_type any Type of maintenance being performed
service_provider string (uri) ✓ Service provider announcing the maintenance

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
message string
maintenance_type any Type of maintenance being performed
service_provider string (uri) Service provider announcing the maintenance
affected_offerings array of objects
affected_offerings.url string (uri)
affected_offerings.uuid string (uuid)
affected_offerings.maintenance string (uri)
affected_offerings.offering string (uri)
affected_offerings.impact_level any Expected impact on this offering
affected_offerings.impact_level_display any
affected_offerings.impact_description string Specific description of how this offering will be affected
affected_offerings.offering_name string

Partially update a maintenance announcement template

Partially updates an existing maintenance announcement template.

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/maintenance-announcements-template/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_maintenance_announcement_template_request import PatchedMaintenanceAnnouncementTemplateRequest # (1)
from waldur_api_client.api.maintenance_announcements_template import maintenance_announcements_template_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedMaintenanceAnnouncementTemplateRequest()
response = maintenance_announcements_template_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedMaintenanceAnnouncementTemplateRequest
  2. API Source: maintenance_announcements_template_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { maintenanceAnnouncementsTemplatePartialUpdate } from 'waldur-js-client';

try {
  const response = await maintenanceAnnouncementsTemplatePartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
name string
message string
maintenance_type any Type of maintenance being performed
service_provider string (uri) Service provider announcing the maintenance

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
message string
maintenance_type any Type of maintenance being performed
service_provider string (uri) Service provider announcing the maintenance
affected_offerings array of objects
affected_offerings.url string (uri)
affected_offerings.uuid string (uuid)
affected_offerings.maintenance string (uri)
affected_offerings.offering string (uri)
affected_offerings.impact_level any Expected impact on this offering
affected_offerings.impact_level_display any
affected_offerings.impact_description string Specific description of how this offering will be affected
affected_offerings.offering_name string

Delete a maintenance announcement template

Deletes a maintenance announcement template.

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/maintenance-announcements-template/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.maintenance_announcements_template import maintenance_announcements_template_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = maintenance_announcements_template_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: maintenance_announcements_template_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { maintenanceAnnouncementsTemplateDestroy } from 'waldur-js-client';

try {
  const response = await maintenanceAnnouncementsTemplateDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Maintenance Announcements

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/maintenance-announcements/ List maintenance announcements
GET /api/maintenance-announcements/{uuid}/ Retrieve a maintenance announcement
POST /api/maintenance-announcements/ Create a maintenance announcement
PUT /api/maintenance-announcements/{uuid}/ Update a maintenance announcement
PATCH /api/maintenance-announcements/{uuid}/ Partially update a maintenance announcement
DELETE /api/maintenance-announcements/{uuid}/ Delete a maintenance announcement
Other Actions
GET /api/maintenance-announcements/maintenance_stats/ Get maintenance announcement statistics
POST /api/maintenance-announcements/{uuid}/cancel_maintenance/ Cancel the maintenance announcement
POST /api/maintenance-announcements/{uuid}/complete_maintenance/ Complete the maintenance announcement
POST /api/maintenance-announcements/{uuid}/schedule/ Schedule/publish the maintenance announcement
POST /api/maintenance-announcements/{uuid}/start_maintenance/ Start the maintenance announcement
POST /api/maintenance-announcements/{uuid}/unschedule/ Unschedule/unpublish the maintenance announcement

Core CRUD

List maintenance announcements

Returns a paginated list of maintenance announcements.

1
2
3
4
http \
  GET \
  https://api.example.com/api/maintenance-announcements/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.maintenance_announcement_o_enum import MaintenanceAnnouncementOEnum # (1)
from waldur_api_client.models.maintenance_announcement_state_enum import MaintenanceAnnouncementStateEnum # (2)
from waldur_api_client.api.maintenance_announcements import maintenance_announcements_list # (3)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = maintenance_announcements_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: MaintenanceAnnouncementOEnum
  2. Model Source: MaintenanceAnnouncementStateEnum
  3. API Source: maintenance_announcements_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { maintenanceAnnouncementsList } from 'waldur-js-client';

try {
  const response = await maintenanceAnnouncementsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
maintenance_type integer Maintenance type
o array Ordering
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
scheduled_end_after string (date-time) Scheduled end after
scheduled_end_before string (date-time) Scheduled end before
scheduled_start_after string (date-time) Scheduled start after
scheduled_start_before string (date-time) Scheduled start before
service_provider_uuid string (uuid) Service provider UUID
state array Maintenance state

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
name string
message string
internal_notes string
maintenance_type any Type of maintenance being performed
external_reference_url string (uri) Optional reference to an external maintenance tracker
state any
scheduled_start string (date-time) When the maintenance is scheduled to begin
scheduled_end string (date-time) When the maintenance is scheduled to complete
actual_start string (date-time) When the maintenance actually began
actual_end string (date-time) When the maintenance actually completed
service_provider string (uri) Service provider announcing the maintenance
created_by string (uri)
affected_offerings array of objects
affected_offerings.url string (uri)
affected_offerings.uuid string (uuid)
affected_offerings.maintenance string (uri)
affected_offerings.offering string (uri)
affected_offerings.impact_level any Expected impact on this offering
affected_offerings.impact_level_display any
affected_offerings.impact_description string Specific description of how this offering will be affected
affected_offerings.offering_name string
service_provider_name string
backend_id string

Retrieve a maintenance announcement

Returns the details of a specific maintenance announcement.

1
2
3
4
http \
  GET \
  https://api.example.com/api/maintenance-announcements/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.maintenance_announcements import maintenance_announcements_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = maintenance_announcements_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: maintenance_announcements_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { maintenanceAnnouncementsRetrieve } from 'waldur-js-client';

try {
  const response = await maintenanceAnnouncementsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
message string
internal_notes string
maintenance_type any Type of maintenance being performed
external_reference_url string (uri) Optional reference to an external maintenance tracker
state any
scheduled_start string (date-time) When the maintenance is scheduled to begin
scheduled_end string (date-time) When the maintenance is scheduled to complete
actual_start string (date-time) When the maintenance actually began
actual_end string (date-time) When the maintenance actually completed
service_provider string (uri) Service provider announcing the maintenance
created_by string (uri)
affected_offerings array of objects
affected_offerings.url string (uri)
affected_offerings.uuid string (uuid)
affected_offerings.maintenance string (uri)
affected_offerings.offering string (uri)
affected_offerings.impact_level any Expected impact on this offering
affected_offerings.impact_level_display any
affected_offerings.impact_description string Specific description of how this offering will be affected
affected_offerings.offering_name string
service_provider_name string
backend_id string

Create a maintenance announcement

Creates a new maintenance announcement in the 'Draft' state.

1
2
3
4
5
6
7
8
http \
  POST \
  https://api.example.com/api/maintenance-announcements/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-maintenance-announcement" \
  scheduled_start="2025-10-01T00:00:00Z" \
  scheduled_end="2025-10-01T00:00:00Z" \
  service_provider="https://api.example.com/api/service-provider/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.maintenance_announcement_request import MaintenanceAnnouncementRequest # (1)
from waldur_api_client.api.maintenance_announcements import maintenance_announcements_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = MaintenanceAnnouncementRequest(
    name="my-awesome-maintenance-announcement",
    scheduled_start="2025-10-01T00:00:00Z",
    scheduled_end="2025-10-01T00:00:00Z",
    service_provider="https://api.example.com/api/service-provider/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = maintenance_announcements_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: MaintenanceAnnouncementRequest
  2. API Source: maintenance_announcements_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { maintenanceAnnouncementsCreate } from 'waldur-js-client';

try {
  const response = await maintenanceAnnouncementsCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "name": "my-awesome-maintenance-announcement",
    "scheduled_start": "2025-10-01T00:00:00Z",
    "scheduled_end": "2025-10-01T00:00:00Z",
    "service_provider": "https://api.example.com/api/service-provider/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
name string ✓
message string
internal_notes string
maintenance_type any Type of maintenance being performed
external_reference_url string (uri) Optional reference to an external maintenance tracker
scheduled_start string (date-time) ✓ When the maintenance is scheduled to begin
scheduled_end string (date-time) ✓ When the maintenance is scheduled to complete
service_provider string (uri) ✓ Service provider announcing the maintenance

201 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
message string
internal_notes string
maintenance_type any Type of maintenance being performed
external_reference_url string (uri) Optional reference to an external maintenance tracker
state any
scheduled_start string (date-time) When the maintenance is scheduled to begin
scheduled_end string (date-time) When the maintenance is scheduled to complete
actual_start string (date-time) When the maintenance actually began
actual_end string (date-time) When the maintenance actually completed
service_provider string (uri) Service provider announcing the maintenance
created_by string (uri)
affected_offerings array of objects
affected_offerings.url string (uri)
affected_offerings.uuid string (uuid)
affected_offerings.maintenance string (uri)
affected_offerings.offering string (uri)
affected_offerings.impact_level any Expected impact on this offering
affected_offerings.impact_level_display any
affected_offerings.impact_description string Specific description of how this offering will be affected
affected_offerings.offering_name string
service_provider_name string
backend_id string

Update a maintenance announcement

Updates an existing maintenance announcement.

1
2
3
4
5
6
7
8
http \
  PUT \
  https://api.example.com/api/maintenance-announcements/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-maintenance-announcement" \
  scheduled_start="2025-10-01T00:00:00Z" \
  scheduled_end="2025-10-01T00:00:00Z" \
  service_provider="https://api.example.com/api/service-provider/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.maintenance_announcement_request import MaintenanceAnnouncementRequest # (1)
from waldur_api_client.api.maintenance_announcements import maintenance_announcements_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = MaintenanceAnnouncementRequest(
    name="my-awesome-maintenance-announcement",
    scheduled_start="2025-10-01T00:00:00Z",
    scheduled_end="2025-10-01T00:00:00Z",
    service_provider="https://api.example.com/api/service-provider/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = maintenance_announcements_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: MaintenanceAnnouncementRequest
  2. API Source: maintenance_announcements_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
import { maintenanceAnnouncementsUpdate } from 'waldur-js-client';

try {
  const response = await maintenanceAnnouncementsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-maintenance-announcement",
    "scheduled_start": "2025-10-01T00:00:00Z",
    "scheduled_end": "2025-10-01T00:00:00Z",
    "service_provider": "https://api.example.com/api/service-provider/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
name string ✓
message string
internal_notes string
maintenance_type any Type of maintenance being performed
external_reference_url string (uri) Optional reference to an external maintenance tracker
scheduled_start string (date-time) ✓ When the maintenance is scheduled to begin
scheduled_end string (date-time) ✓ When the maintenance is scheduled to complete
service_provider string (uri) ✓ Service provider announcing the maintenance

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
message string
internal_notes string
maintenance_type any Type of maintenance being performed
external_reference_url string (uri) Optional reference to an external maintenance tracker
state any
scheduled_start string (date-time) When the maintenance is scheduled to begin
scheduled_end string (date-time) When the maintenance is scheduled to complete
actual_start string (date-time) When the maintenance actually began
actual_end string (date-time) When the maintenance actually completed
service_provider string (uri) Service provider announcing the maintenance
created_by string (uri)
affected_offerings array of objects
affected_offerings.url string (uri)
affected_offerings.uuid string (uuid)
affected_offerings.maintenance string (uri)
affected_offerings.offering string (uri)
affected_offerings.impact_level any Expected impact on this offering
affected_offerings.impact_level_display any
affected_offerings.impact_description string Specific description of how this offering will be affected
affected_offerings.offering_name string
service_provider_name string
backend_id string

Partially update a maintenance announcement

Partially updates an existing maintenance announcement.

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/maintenance-announcements/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_maintenance_announcement_request import PatchedMaintenanceAnnouncementRequest # (1)
from waldur_api_client.api.maintenance_announcements import maintenance_announcements_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedMaintenanceAnnouncementRequest()
response = maintenance_announcements_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedMaintenanceAnnouncementRequest
  2. API Source: maintenance_announcements_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { maintenanceAnnouncementsPartialUpdate } from 'waldur-js-client';

try {
  const response = await maintenanceAnnouncementsPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
name string
message string
internal_notes string
maintenance_type any Type of maintenance being performed
external_reference_url string (uri) Optional reference to an external maintenance tracker
scheduled_start string (date-time) When the maintenance is scheduled to begin
scheduled_end string (date-time) When the maintenance is scheduled to complete
service_provider string (uri) Service provider announcing the maintenance

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
message string
internal_notes string
maintenance_type any Type of maintenance being performed
external_reference_url string (uri) Optional reference to an external maintenance tracker
state any
scheduled_start string (date-time) When the maintenance is scheduled to begin
scheduled_end string (date-time) When the maintenance is scheduled to complete
actual_start string (date-time) When the maintenance actually began
actual_end string (date-time) When the maintenance actually completed
service_provider string (uri) Service provider announcing the maintenance
created_by string (uri)
affected_offerings array of objects
affected_offerings.url string (uri)
affected_offerings.uuid string (uuid)
affected_offerings.maintenance string (uri)
affected_offerings.offering string (uri)
affected_offerings.impact_level any Expected impact on this offering
affected_offerings.impact_level_display any
affected_offerings.impact_description string Specific description of how this offering will be affected
affected_offerings.offering_name string
service_provider_name string
backend_id string

Delete a maintenance announcement

Deletes a maintenance announcement.

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/maintenance-announcements/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.maintenance_announcements import maintenance_announcements_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = maintenance_announcements_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: maintenance_announcements_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { maintenanceAnnouncementsDestroy } from 'waldur-js-client';

try {
  const response = await maintenanceAnnouncementsDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Other Actions

Get maintenance announcement statistics

Returns comprehensive statistics for maintenance announcements including counts by state, type, impact level, and daily breakdown.

1
2
3
4
http \
  GET \
  https://api.example.com/api/maintenance-announcements/maintenance_stats/ \
  Authorization:"Token YOUR_API_TOKEN"

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.maintenance_announcements import maintenance_announcements_maintenance_stats_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = maintenance_announcements_maintenance_stats_retrieve.sync(client=client)

print(response)
  1. API Source: maintenance_announcements_maintenance_stats_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { maintenanceAnnouncementsMaintenanceStatsRetrieve } from 'waldur-js-client';

try {
  const response = await maintenanceAnnouncementsMaintenanceStatsRetrieve({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
end string End date in YYYY-MM-DD format. Defaults to 30 days in the future.
provider_uuid string Filter by service provider UUID.
start string Start date in YYYY-MM-DD format. Defaults to 90 days ago.

200 -

Field Type Description
summary any Summary statistics
by_state object (free-form) Total counts grouped by state
by_type object (free-form) Total counts grouped by maintenance type
by_impact_level object (free-form) Total counts grouped by max impact level
daily array of objects Daily breakdown
daily.date string (date) Date
daily.count integer Number of maintenances on this day
daily.by_state object (free-form) Maintenance counts grouped by state
providers array of objects Statistics per provider
providers.uuid string Service provider UUID
providers.name string Service provider name
providers.total integer Total maintenances
providers.active integer Active maintenances
providers.scheduled integer Scheduled maintenances
providers.completed integer Completed maintenances

Cancel the maintenance announcement

Transitions a 'Draft' or 'Scheduled' maintenance announcement to 'Cancelled'.

1
2
3
4
http \
  POST \
  https://api.example.com/api/maintenance-announcements/a1b2c3d4-e5f6-7890-abcd-ef1234567890/cancel_maintenance/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.maintenance_announcements import maintenance_announcements_cancel_maintenance # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = maintenance_announcements_cancel_maintenance.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: maintenance_announcements_cancel_maintenance
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { maintenanceAnnouncementsCancelMaintenance } from 'waldur-js-client';

try {
  const response = await maintenanceAnnouncementsCancelMaintenance({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
detail string Response message describing the action result

Complete the maintenance announcement

Transitions an 'In progress' maintenance announcement to 'Completed', indicating that the maintenance work has finished.

1
2
3
4
http \
  POST \
  https://api.example.com/api/maintenance-announcements/a1b2c3d4-e5f6-7890-abcd-ef1234567890/complete_maintenance/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.maintenance_announcements import maintenance_announcements_complete_maintenance # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = maintenance_announcements_complete_maintenance.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: maintenance_announcements_complete_maintenance
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { maintenanceAnnouncementsCompleteMaintenance } from 'waldur-js-client';

try {
  const response = await maintenanceAnnouncementsCompleteMaintenance({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
detail string Response message describing the action result

Schedule/publish the maintenance announcement

Transitions a 'Draft' maintenance announcement to the 'Scheduled' state, making it publicly visible.

1
2
3
4
http \
  POST \
  https://api.example.com/api/maintenance-announcements/a1b2c3d4-e5f6-7890-abcd-ef1234567890/schedule/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.maintenance_announcements import maintenance_announcements_schedule # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = maintenance_announcements_schedule.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: maintenance_announcements_schedule
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { maintenanceAnnouncementsSchedule } from 'waldur-js-client';

try {
  const response = await maintenanceAnnouncementsSchedule({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
detail string Response message describing the action result

Start the maintenance announcement

Transitions a 'Scheduled' maintenance announcement to 'In progress', indicating that the maintenance work has begun.

1
2
3
4
http \
  POST \
  https://api.example.com/api/maintenance-announcements/a1b2c3d4-e5f6-7890-abcd-ef1234567890/start_maintenance/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.maintenance_announcements import maintenance_announcements_start_maintenance # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = maintenance_announcements_start_maintenance.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: maintenance_announcements_start_maintenance
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { maintenanceAnnouncementsStartMaintenance } from 'waldur-js-client';

try {
  const response = await maintenanceAnnouncementsStartMaintenance({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
detail string Response message describing the action result

Unschedule/unpublish the maintenance announcement

Transitions a 'Scheduled' maintenance announcement back to the 'Draft' state, hiding it from public view.

1
2
3
4
http \
  POST \
  https://api.example.com/api/maintenance-announcements/a1b2c3d4-e5f6-7890-abcd-ef1234567890/unschedule/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.maintenance_announcements import maintenance_announcements_unschedule # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = maintenance_announcements_unschedule.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: maintenance_announcements_unschedule
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { maintenanceAnnouncementsUnschedule } from 'waldur-js-client';

try {
  const response = await maintenanceAnnouncementsUnschedule({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
detail string Response message describing the action result

Public Maintenance Announcements

Operations Summary

Method Endpoint Description
GET /api/public-maintenance-announcements/ List public maintenance announcements
GET /api/public-maintenance-announcements/{uuid}/ Retrieve a public maintenance announcement

List public maintenance announcements

Returns a paginated list of public maintenance announcements. Only announcements that are 'Scheduled', 'In progress', or 'Completed' are visible. This endpoint is accessible to unauthenticated users.

1
2
3
4
http \
  GET \
  https://api.example.com/api/public-maintenance-announcements/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.maintenance_announcement_o_enum import MaintenanceAnnouncementOEnum # (1)
from waldur_api_client.models.maintenance_announcement_state_enum import MaintenanceAnnouncementStateEnum # (2)
from waldur_api_client.api.public_maintenance_announcements import public_maintenance_announcements_list # (3)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = public_maintenance_announcements_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: MaintenanceAnnouncementOEnum
  2. Model Source: MaintenanceAnnouncementStateEnum
  3. API Source: public_maintenance_announcements_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { publicMaintenanceAnnouncementsList } from 'waldur-js-client';

try {
  const response = await publicMaintenanceAnnouncementsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
maintenance_type integer Maintenance type
o array Ordering
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
scheduled_end_after string (date-time) Scheduled end after
scheduled_end_before string (date-time) Scheduled end before
scheduled_start_after string (date-time) Scheduled start after
scheduled_start_before string (date-time) Scheduled start before
service_provider_uuid string (uuid) Service provider UUID
state array Maintenance state

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
name string
message string
maintenance_type any Type of maintenance being performed
maintenance_type_display string
external_reference_url string (uri) Optional reference to an external maintenance tracker
state any
scheduled_start string (date-time) When the maintenance is scheduled to begin
scheduled_end string (date-time) When the maintenance is scheduled to complete
actual_start string (date-time) When the maintenance actually began
actual_end string (date-time) When the maintenance actually completed
affected_offerings array of objects
affected_offerings.url string (uri)
affected_offerings.uuid string (uuid)
affected_offerings.maintenance string (uri)
affected_offerings.offering string (uri)
affected_offerings.impact_level any Expected impact on this offering
affected_offerings.impact_level_display any
affected_offerings.impact_description string Specific description of how this offering will be affected
affected_offerings.offering_name string
service_provider_name string

Retrieve a public maintenance announcement

Returns the details of a specific public maintenance announcement.

1
2
3
4
http \
  GET \
  https://api.example.com/api/public-maintenance-announcements/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.public_maintenance_announcements import public_maintenance_announcements_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = public_maintenance_announcements_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: public_maintenance_announcements_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { publicMaintenanceAnnouncementsRetrieve } from 'waldur-js-client';

try {
  const response = await publicMaintenanceAnnouncementsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
message string
maintenance_type any Type of maintenance being performed
maintenance_type_display string
external_reference_url string (uri) Optional reference to an external maintenance tracker
state any
scheduled_start string (date-time) When the maintenance is scheduled to begin
scheduled_end string (date-time) When the maintenance is scheduled to complete
actual_start string (date-time) When the maintenance actually began
actual_end string (date-time) When the maintenance actually completed
affected_offerings array of objects
affected_offerings.url string (uri)
affected_offerings.uuid string (uuid)
affected_offerings.maintenance string (uri)
affected_offerings.offering string (uri)
affected_offerings.impact_level any Expected impact on this offering
affected_offerings.impact_level_display any
affected_offerings.impact_description string Specific description of how this offering will be affected
affected_offerings.offering_name string
service_provider_name string

Offerings

Marketplace Demo Presets

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/marketplace-demo-presets/list/ List demo presets
Other Actions
GET /api/marketplace-demo-presets/info/{name}/ Get demo preset details
POST /api/marketplace-demo-presets/load/{name}/ Load demo preset

Core CRUD

List demo presets

Returns a list of available demo data presets. Staff access only.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-demo-presets/list/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_demo_presets import marketplace_demo_presets_list_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_demo_presets_list_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: marketplace_demo_presets_list_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceDemoPresetsListList } from 'waldur-js-client';

try {
  const response = await marketplaceDemoPresetsListList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
name string
title string
description string
version string
entity_counts object (free-form)
scenarios array of strings

Other Actions

Get demo preset details

Returns detailed information about a specific demo preset. Staff access only.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-demo-presets/info/my-awesome-resource/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_demo_presets import marketplace_demo_presets_info_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_demo_presets_info_retrieve.sync(
    name="my-awesome-resource",
    client=client
)

print(response)
  1. API Source: marketplace_demo_presets_info_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceDemoPresetsInfoRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceDemoPresetsInfoRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "name": "my-awesome-resource"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
name string ✓ Name of the preset

200 -

Field Type
name string
title string
description string
version string
entity_counts object (free-form)
scenarios array of strings

404 - No response body

Load demo preset

Load a demo preset into the database. This operation will optionally clean up existing data before loading. Staff access only.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-demo-presets/load/my-awesome-resource/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.demo_preset_load_request_request import DemoPresetLoadRequestRequest # (1)
from waldur_api_client.api.marketplace_demo_presets import marketplace_demo_presets_load # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = DemoPresetLoadRequestRequest()
response = marketplace_demo_presets_load.sync(
    name="my-awesome-resource",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: DemoPresetLoadRequestRequest
  2. API Source: marketplace_demo_presets_load
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceDemoPresetsLoad } from 'waldur-js-client';

try {
  const response = await marketplaceDemoPresetsLoad({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "name": "my-awesome-resource"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
name string ✓ Name of the preset to load
Field Type Required Description
dry_run boolean Preview changes without applying them
Constraints: default: False
cleanup_first boolean Clean up existing data before loading the preset
Constraints: default: True
skip_users boolean Skip user import/cleanup
Constraints: default: False
skip_roles boolean Skip role import/cleanup
Constraints: default: False

200 -

Field Type
success boolean
message string
output string
users array of objects
users.username string
users.password string
users.email string
users.is_staff boolean
users.is_support boolean

400 - No response body

404 - No response body

Marketplace Offering Files

Operations Summary

Method Endpoint Description
GET /api/marketplace-offering-files/ List Marketplace Offering Files
GET /api/marketplace-offering-files/{uuid}/ Retrieve
POST /api/marketplace-offering-files/ Create
DELETE /api/marketplace-offering-files/{uuid}/ Delete

List Marketplace Offering Files

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-offering-files/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.maintenance_announcement_template_o_enum import MaintenanceAnnouncementTemplateOEnum # (1)
from waldur_api_client.models.offering_file_field_enum import OfferingFileFieldEnum # (2)
from waldur_api_client.api.marketplace_offering_files import marketplace_offering_files_list # (3)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_offering_files_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: MaintenanceAnnouncementTemplateOEnum
  2. Model Source: OfferingFileFieldEnum
  3. API Source: marketplace_offering_files_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceOfferingFilesList } from 'waldur-js-client';

try {
  const response = await marketplaceOfferingFilesList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
field array
o array Ordering
offering string (uri)
offering_slug array Multiple values may be separated by commas.
offering_uuid array Multiple values may be separated by commas.
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
parent_offering_uuid string (uuid)

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
url string (uri)
uuid string (uuid)
name string
offering string (uri)
created string (date-time)
file string (uri)

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-offering-files/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.offering_file_field_enum import OfferingFileFieldEnum # (1)
from waldur_api_client.api.marketplace_offering_files import marketplace_offering_files_retrieve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_offering_files_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. Model Source: OfferingFileFieldEnum
  2. API Source: marketplace_offering_files_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceOfferingFilesRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceOfferingFilesRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type
field array

200 -

Field Type
url string (uri)
uuid string (uuid)
name string
offering string (uri)
created string (date-time)
file string (uri)

Create

1
2
3
4
5
6
7
http \
  POST \
  https://api.example.com/api/marketplace-offering-files/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-marketplace-offering-file" \
  offering="https://api.example.com/api/offering/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  file="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.offering_file_request import OfferingFileRequest # (1)
from waldur_api_client.api.marketplace_offering_files import marketplace_offering_files_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OfferingFileRequest(
    name="my-awesome-marketplace-offering-file",
    offering="https://api.example.com/api/offering/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    file="string-value"
)
response = marketplace_offering_files_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OfferingFileRequest
  2. API Source: marketplace_offering_files_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
import { marketplaceOfferingFilesCreate } from 'waldur-js-client';

try {
  const response = await marketplaceOfferingFilesCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "name": "my-awesome-marketplace-offering-file",
    "offering": "https://api.example.com/api/offering/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "file": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required
name string ✓
offering string (uri) ✓
file string (binary) ✓

201 -

Field Type
url string (uri)
uuid string (uuid)
name string
offering string (uri)
created string (date-time)
file string (uri)

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/marketplace-offering-files/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_offering_files import marketplace_offering_files_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_offering_files_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_offering_files_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceOfferingFilesDestroy } from 'waldur-js-client';

try {
  const response = await marketplaceOfferingFilesDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Marketplace Offering Permissions Log

Operations Summary

Method Endpoint Description
GET /api/marketplace-offering-permissions-log/ List Marketplace Offering Permissions Log
GET /api/marketplace-offering-permissions-log/{id}/ Retrieve

List Marketplace Offering Permissions Log

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-offering-permissions-log/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.offering_permission_o_enum import OfferingPermissionOEnum # (1)
from waldur_api_client.api.marketplace_offering_permissions_log import marketplace_offering_permissions_log_list # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_offering_permissions_log_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: OfferingPermissionOEnum
  2. API Source: marketplace_offering_permissions_log_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceOfferingPermissionsLogList } from 'waldur-js-client';

try {
  const response = await marketplaceOfferingPermissionsLogList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
created string (date-time) Created after
customer string (uuid)
full_name string User full name contains
modified string (date-time) Modified after
native_name string
o array Ordering
offering string (uuid)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
role_name string Role name contains
role_uuid string (uuid) Role UUID
scope_name string Scope name
scope_type string Scope type
scope_uuid string Scope UUID
user string (uuid)
user_slug string User slug contains
user_url string (uri)
username string

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
pk integer
created string (date-time)
expiration_time string (date-time)
created_by string (uri)
offering string (uri)
offering_uuid string (uuid)
offering_slug string
offering_name string
role string (uri)
role_name string
user string (uri)
user_full_name string
user_native_name string
user_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
user_uuid string (uuid)
user_email string (email)

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-offering-permissions-log/123/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_offering_permissions_log import marketplace_offering_permissions_log_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_offering_permissions_log_retrieve.sync(
    id=123,
    client=client
)

print(response)
  1. API Source: marketplace_offering_permissions_log_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceOfferingPermissionsLogRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceOfferingPermissionsLogRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "id": 123
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
id integer ✓ A unique integer value identifying this user role.

200 -

Field Type Description
url string (uri)
pk integer
created string (date-time)
expiration_time string (date-time)
created_by string (uri)
offering string (uri)
offering_uuid string (uuid)
offering_slug string
offering_name string
role string (uri)
role_name string
user string (uri)
user_full_name string
user_native_name string
user_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
user_uuid string (uuid)
user_email string (email)

Marketplace Offering Permissions

Operations Summary

Method Endpoint Description
GET /api/marketplace-offering-permissions/ List Marketplace Offering Permissions
GET /api/marketplace-offering-permissions/{id}/ Retrieve

List Marketplace Offering Permissions

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-offering-permissions/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.offering_permission_o_enum import OfferingPermissionOEnum # (1)
from waldur_api_client.api.marketplace_offering_permissions import marketplace_offering_permissions_list # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_offering_permissions_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: OfferingPermissionOEnum
  2. API Source: marketplace_offering_permissions_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceOfferingPermissionsList } from 'waldur-js-client';

try {
  const response = await marketplaceOfferingPermissionsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
created string (date-time) Created after
customer string (uuid)
full_name string User full name contains
modified string (date-time) Modified after
native_name string
o array Ordering
offering string (uuid)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
role_name string Role name contains
role_uuid string (uuid) Role UUID
scope_name string Scope name
scope_type string Scope type
scope_uuid string Scope UUID
user string (uuid)
user_slug string User slug contains
user_url string (uri)
username string

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
pk integer
created string (date-time)
expiration_time string (date-time)
created_by string (uri)
offering string (uri)
offering_uuid string (uuid)
offering_slug string
offering_name string
role string (uri)
role_name string
user string (uri)
user_full_name string
user_native_name string
user_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
user_uuid string (uuid)
user_email string (email)

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-offering-permissions/123/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_offering_permissions import marketplace_offering_permissions_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_offering_permissions_retrieve.sync(
    id=123,
    client=client
)

print(response)
  1. API Source: marketplace_offering_permissions_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceOfferingPermissionsRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceOfferingPermissionsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "id": 123
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
id integer ✓ A unique integer value identifying this user role.

200 -

Field Type Description
url string (uri)
pk integer
created string (date-time)
expiration_time string (date-time)
created_by string (uri)
offering string (uri)
offering_uuid string (uuid)
offering_slug string
offering_name string
role string (uri)
role_name string
user string (uri)
user_full_name string
user_native_name string
user_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
user_uuid string (uuid)
user_email string (email)

Marketplace Offering Referrals

Operations Summary

Method Endpoint Description
GET /api/marketplace-offering-referrals/ List Datacite referrals for offerings
GET /api/marketplace-offering-referrals/{uuid}/ Retrieve a specific Datacite referral

List Datacite referrals for offerings

Returns a paginated list of Datacite referrals associated with marketplace offerings. Referrals represent relationships between an offering (identified by a DOI) and other research outputs, such as publications or datasets. The list must be filtered by the offering's scope.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-offering-referrals/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.offering_referral_o_enum import OfferingReferralOEnum # (1)
from waldur_api_client.api.marketplace_offering_referrals import marketplace_offering_referrals_list # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_offering_referrals_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: OfferingReferralOEnum
  2. API Source: marketplace_offering_referrals_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceOfferingReferralsList } from 'waldur-js-client';

try {
  const response = await marketplaceOfferingReferralsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
o array Ordering
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
scope string (uri) Filter by scope URL.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
url string (uri)
uuid string (uuid)
scope string
scope_uuid string (uuid)
pid string
relation_type string
resource_type string
creator string
publisher string
published string
title string
referral_url string

Retrieve a specific Datacite referral

Returns the details of a single Datacite referral record, identified by its UUID. Details include the related identifier (PID), the type of relationship, and metadata about the related work.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-offering-referrals/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_offering_referrals import marketplace_offering_referrals_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_offering_referrals_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_offering_referrals_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceOfferingReferralsRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceOfferingReferralsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
url string (uri)
uuid string (uuid)
scope string
scope_uuid string (uuid)
pid string
relation_type string
resource_type string
creator string
publisher string
published string
title string
referral_url string

Marketplace Offering Terms Of Service

Operations Summary

Method Endpoint Description
GET /api/marketplace-offering-terms-of-service/ List Terms of Service configurations
GET /api/marketplace-offering-terms-of-service/{uuid}/ Retrieve a Terms of Service configuration
POST /api/marketplace-offering-terms-of-service/ Create a Terms of Service configuration
PUT /api/marketplace-offering-terms-of-service/{uuid}/ Update a Terms of Service configuration
PATCH /api/marketplace-offering-terms-of-service/{uuid}/ Partially update a Terms of Service configuration
DELETE /api/marketplace-offering-terms-of-service/{uuid}/ Delete a Terms of Service configuration

List Terms of Service configurations

Returns a paginated list of Terms of Service configurations for offerings. Visibility depends on user permissions: staff/support see all; service providers see their own; regular users see ToS for offerings they have consented to or shared offerings.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-offering-terms-of-service/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.offering_terms_of_service_o_enum import OfferingTermsOfServiceOEnum # (1)
from waldur_api_client.api.marketplace_offering_terms_of_service import marketplace_offering_terms_of_service_list # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_offering_terms_of_service_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: OfferingTermsOfServiceOEnum
  2. API Source: marketplace_offering_terms_of_service_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceOfferingTermsOfServiceList } from 'waldur-js-client';

try {
  const response = await marketplaceOfferingTermsOfServiceList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
is_active boolean Is active
o array Ordering
offering string (uri) Offering URL
offering_uuid string (uuid) Offering UUID
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
requires_reconsent boolean Requires reconsent
version string Version

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid)
offering_uuid string (uuid)
offering_name string
terms_of_service string
terms_of_service_link string (uri)
version string
is_active boolean
requires_reconsent boolean If True, user will be asked to re-consent to the terms of service when the terms of service are updated.
grace_period_days integer Number of days before outdated consents are automatically revoked. Only applies when requires_reconsent=True.
user_consent any
has_user_consent boolean
created string (date-time)
modified string (date-time)

Retrieve a Terms of Service configuration

Returns the details of a specific Terms of Service configuration.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-offering-terms-of-service/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_offering_terms_of_service import marketplace_offering_terms_of_service_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_offering_terms_of_service_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_offering_terms_of_service_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceOfferingTermsOfServiceRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceOfferingTermsOfServiceRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
uuid string (uuid)
offering_uuid string (uuid)
offering_name string
terms_of_service string
terms_of_service_link string (uri)
version string
is_active boolean
requires_reconsent boolean If True, user will be asked to re-consent to the terms of service when the terms of service are updated.
grace_period_days integer Number of days before outdated consents are automatically revoked. Only applies when requires_reconsent=True.
user_consent any
has_user_consent boolean
created string (date-time)
modified string (date-time)

Create a Terms of Service configuration

Creates a new Terms of Service configuration for an offering. Only one active ToS configuration is allowed per offering.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/marketplace-offering-terms-of-service/ \
  Authorization:"Token YOUR_API_TOKEN" \
  offering="https://api.example.com/api/offering/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.offering_terms_of_service_create_request import OfferingTermsOfServiceCreateRequest # (1)
from waldur_api_client.api.marketplace_offering_terms_of_service import marketplace_offering_terms_of_service_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OfferingTermsOfServiceCreateRequest(
    offering="https://api.example.com/api/offering/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = marketplace_offering_terms_of_service_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OfferingTermsOfServiceCreateRequest
  2. API Source: marketplace_offering_terms_of_service_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceOfferingTermsOfServiceCreate } from 'waldur-js-client';

try {
  const response = await marketplaceOfferingTermsOfServiceCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "offering": "https://api.example.com/api/offering/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
offering string (uri) ✓
terms_of_service string
terms_of_service_link string (uri)
version string
is_active boolean
requires_reconsent boolean If True, user will be asked to re-consent to the terms of service when the terms of service are updated.
grace_period_days integer Number of days before outdated consents are automatically revoked. Only applies when requires_reconsent=True.

201 -

Field Type Description
offering string (uri)
terms_of_service string
terms_of_service_link string (uri)
version string
is_active boolean
requires_reconsent boolean If True, user will be asked to re-consent to the terms of service when the terms of service are updated.
grace_period_days integer Number of days before outdated consents are automatically revoked. Only applies when requires_reconsent=True.

Update a Terms of Service configuration

Updates an existing Terms of Service configuration. Note that some fields like version and requires_reconsent are protected and cannot be changed after creation.

1
2
3
4
http \
  PUT \
  https://api.example.com/api/marketplace-offering-terms-of-service/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.offering_terms_of_service_request import OfferingTermsOfServiceRequest # (1)
from waldur_api_client.api.marketplace_offering_terms_of_service import marketplace_offering_terms_of_service_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OfferingTermsOfServiceRequest()
response = marketplace_offering_terms_of_service_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OfferingTermsOfServiceRequest
  2. API Source: marketplace_offering_terms_of_service_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceOfferingTermsOfServiceUpdate } from 'waldur-js-client';

try {
  const response = await marketplaceOfferingTermsOfServiceUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
terms_of_service string
terms_of_service_link string (uri)
is_active boolean
grace_period_days integer Number of days before outdated consents are automatically revoked. Only applies when requires_reconsent=True.

200 -

Field Type Description
uuid string (uuid)
offering_uuid string (uuid)
offering_name string
terms_of_service string
terms_of_service_link string (uri)
version string
is_active boolean
requires_reconsent boolean If True, user will be asked to re-consent to the terms of service when the terms of service are updated.
grace_period_days integer Number of days before outdated consents are automatically revoked. Only applies when requires_reconsent=True.
user_consent any
has_user_consent boolean
created string (date-time)
modified string (date-time)

Partially update a Terms of Service configuration

Partially updates an existing Terms of Service configuration.

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/marketplace-offering-terms-of-service/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_offering_terms_of_service_request import PatchedOfferingTermsOfServiceRequest # (1)
from waldur_api_client.api.marketplace_offering_terms_of_service import marketplace_offering_terms_of_service_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedOfferingTermsOfServiceRequest()
response = marketplace_offering_terms_of_service_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedOfferingTermsOfServiceRequest
  2. API Source: marketplace_offering_terms_of_service_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceOfferingTermsOfServicePartialUpdate } from 'waldur-js-client';

try {
  const response = await marketplaceOfferingTermsOfServicePartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
terms_of_service string
terms_of_service_link string (uri)
is_active boolean
grace_period_days integer Number of days before outdated consents are automatically revoked. Only applies when requires_reconsent=True.

200 -

Field Type Description
uuid string (uuid)
offering_uuid string (uuid)
offering_name string
terms_of_service string
terms_of_service_link string (uri)
version string
is_active boolean
requires_reconsent boolean If True, user will be asked to re-consent to the terms of service when the terms of service are updated.
grace_period_days integer Number of days before outdated consents are automatically revoked. Only applies when requires_reconsent=True.
user_consent any
has_user_consent boolean
created string (date-time)
modified string (date-time)

Delete a Terms of Service configuration

Deletes a Terms of Service configuration. This is a hard delete and should be used with caution.

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/marketplace-offering-terms-of-service/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_offering_terms_of_service import marketplace_offering_terms_of_service_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_offering_terms_of_service_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_offering_terms_of_service_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceOfferingTermsOfServiceDestroy } from 'waldur-js-client';

try {
  const response = await marketplaceOfferingTermsOfServiceDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Marketplace Plan Components

Operations Summary

Method Endpoint Description
GET /api/marketplace-plan-components/ List plan components
GET /api/marketplace-plan-components/{id}/ Retrieve a plan component

List plan components

Returns a paginated list of all plan components. A plan component defines the pricing and quotas for an offering component within a billing plan. The list is filtered based on the current user's access permissions and organization group memberships.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-plan-components/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_plan_components import marketplace_plan_components_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_plan_components_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: marketplace_plan_components_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplacePlanComponentsList } from 'waldur-js-client';

try {
  const response = await marketplacePlanComponentsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
archived boolean Archived
offering_uuid string (uuid) Offering UUID
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
plan_uuid string (uuid) Plan UUID
shared boolean Shared

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
offering_uuid string (uuid)
offering_name string
plan_uuid string (uuid)
plan_name string
plan_unit any
component_name string Display name for the measured unit, for example, Floating IP.
measured_unit string Unit of measurement, for example, GB.
billing_type any
amount integer
price string (decimal)
future_price string (decimal)
discount_threshold integer Minimum amount to be eligible for discount.
discount_rate integer Discount rate in percentage.

Retrieve a plan component

Returns the details of a specific plan component, including its pricing, quotas, and associated offering and plan information.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-plan-components/123/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_plan_components import marketplace_plan_components_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_plan_components_retrieve.sync(
    id=123,
    client=client
)

print(response)
  1. API Source: marketplace_plan_components_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplacePlanComponentsRetrieve } from 'waldur-js-client';

try {
  const response = await marketplacePlanComponentsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "id": 123
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
id integer ✓ A unique integer value identifying this plan component.

200 -

Field Type Description
offering_uuid string (uuid)
offering_name string
plan_uuid string (uuid)
plan_name string
plan_unit any
component_name string Display name for the measured unit, for example, Floating IP.
measured_unit string Unit of measurement, for example, GB.
billing_type any
amount integer
price string (decimal)
future_price string (decimal)
discount_threshold integer Minimum amount to be eligible for discount.
discount_rate integer Discount rate in percentage.

Marketplace Plans

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/marketplace-plans/ List provider plans
GET /api/marketplace-plans/{uuid}/ Retrieve a provider plan
POST /api/marketplace-plans/ Create a provider plan
POST /api/marketplace-plans/{uuid}/update_discounts/ Update plan component discounts
POST /api/marketplace-plans/{uuid}/update_organization_groups/ Update organization groups for a plan
POST /api/marketplace-plans/{uuid}/update_prices/ Update plan component prices
POST /api/marketplace-plans/{uuid}/update_quotas/ Update plan component quotas
PUT /api/marketplace-plans/{uuid}/ Update a provider plan
PATCH /api/marketplace-plans/{uuid}/ Partially update a provider plan
DELETE /api/marketplace-plans/{uuid}/ Delete a provider plan
Other Actions
GET /api/marketplace-plans/{uuid}/history/at/ Get object state at a specific timestamp
GET /api/marketplace-plans/{uuid}/history/ Get version history
GET /api/marketplace-plans/usage_stats/ Get plan usage statistics
POST /api/marketplace-plans/{uuid}/archive/ Archive a plan
POST /api/marketplace-plans/{uuid}/delete_organization_groups/ Remove all organization groups from a plan

Core CRUD

List provider plans

Returns a paginated list of plans managed by the provider. The list is filtered based on the current user's access to the offering's customer.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-plans/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_plans import marketplace_plans_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_plans_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: marketplace_plans_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplacePlansList } from 'waldur-js-client';

try {
  const response = await marketplacePlansList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
offering string (uri)
offering_slug array Multiple values may be separated by commas.
offering_uuid string (uuid) Offering UUID
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
parent_offering_uuid string (uuid)

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
article_code string
max_amount integer Maximum number of plans that could be active. Plan is disabled when maximum amount is reached.
archived boolean Forbids creation of new resources.
is_active boolean
unit_price string (decimal)
unit string
Enum: month, quarter, half_month, day, hour, quantity
init_price number (double)
switch_price number (double)
backend_id string
organization_groups array of objects
organization_groups.uuid string (uuid)
organization_groups.url string (uri)
organization_groups.name string
organization_groups.parent_uuid string (uuid) UUID of the parent organization group
organization_groups.parent_name string Name of the parent organization group
organization_groups.parent string (uri)
organization_groups.customers_count integer Number of customers in this organization group
components array of objects
components.type string Unique internal name of the measured unit, for example floating_ip.
components.name string Display name for the measured unit, for example, Floating IP.
components.measured_unit string Unit of measurement, for example, GB.
components.amount integer
components.price string (decimal)
components.future_price string (decimal)
components.discount_threshold integer Minimum amount to be eligible for discount.
components.discount_rate integer Discount rate in percentage.
offering string (uri)
prices object (free-form)
future_prices object (free-form)
quotas object (free-form)
resources_count integer
plan_type string
minimal_price number (double)

Retrieve a provider plan

Returns details of a specific plan.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-plans/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_plans import marketplace_plans_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_plans_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_plans_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplacePlansRetrieve } from 'waldur-js-client';

try {
  const response = await marketplacePlansRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
article_code string
max_amount integer Maximum number of plans that could be active. Plan is disabled when maximum amount is reached.
archived boolean Forbids creation of new resources.
is_active boolean
unit_price string (decimal)
unit string
Enum: month, quarter, half_month, day, hour, quantity
init_price number (double)
switch_price number (double)
backend_id string
organization_groups array of objects
organization_groups.uuid string (uuid)
organization_groups.url string (uri)
organization_groups.name string
organization_groups.parent_uuid string (uuid) UUID of the parent organization group
organization_groups.parent_name string Name of the parent organization group
organization_groups.parent string (uri)
organization_groups.customers_count integer Number of customers in this organization group
components array of objects
components.type string Unique internal name of the measured unit, for example floating_ip.
components.name string Display name for the measured unit, for example, Floating IP.
components.measured_unit string Unit of measurement, for example, GB.
components.amount integer
components.price string (decimal)
components.future_price string (decimal)
components.discount_threshold integer Minimum amount to be eligible for discount.
components.discount_rate integer Discount rate in percentage.
offering string (uri)
prices object (free-form)
future_prices object (free-form)
quotas object (free-form)
resources_count integer
plan_type string
minimal_price number (double)

Create a provider plan

Creates a new billing plan for an offering.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/marketplace-plans/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-marketplace-plan" \
  offering="https://api.example.com/api/offering/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.provider_plan_details_request import ProviderPlanDetailsRequest # (1)
from waldur_api_client.api.marketplace_plans import marketplace_plans_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ProviderPlanDetailsRequest(
    name="my-awesome-marketplace-plan",
    offering="https://api.example.com/api/offering/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = marketplace_plans_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ProviderPlanDetailsRequest
  2. API Source: marketplace_plans_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { marketplacePlansCreate } from 'waldur-js-client';

try {
  const response = await marketplacePlansCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "name": "my-awesome-marketplace-plan",
    "offering": "https://api.example.com/api/offering/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
name string ✓
description string
article_code string
max_amount integer Maximum number of plans that could be active. Plan is disabled when maximum amount is reached.
archived boolean Forbids creation of new resources.
unit_price string (decimal)
unit string
Enum: month, quarter, half_month, day, hour, quantity
backend_id string
offering string (uri) ✓

201 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
article_code string
max_amount integer Maximum number of plans that could be active. Plan is disabled when maximum amount is reached.
archived boolean Forbids creation of new resources.
is_active boolean
unit_price string (decimal)
unit string
Enum: month, quarter, half_month, day, hour, quantity
init_price number (double)
switch_price number (double)
backend_id string
organization_groups array of objects
organization_groups.uuid string (uuid)
organization_groups.url string (uri)
organization_groups.name string
organization_groups.parent_uuid string (uuid) UUID of the parent organization group
organization_groups.parent_name string Name of the parent organization group
organization_groups.parent string (uri)
organization_groups.customers_count integer Number of customers in this organization group
components array of objects
components.type string Unique internal name of the measured unit, for example floating_ip.
components.name string Display name for the measured unit, for example, Floating IP.
components.measured_unit string Unit of measurement, for example, GB.
components.amount integer
components.price string (decimal)
components.future_price string (decimal)
components.discount_threshold integer Minimum amount to be eligible for discount.
components.discount_rate integer Discount rate in percentage.
offering string (uri)
prices object (free-form)
future_prices object (free-form)
quotas object (free-form)
resources_count integer
plan_type string
minimal_price number (double)

Update plan component discounts

1
2
3
4
5
6
7
8
9
    Update volume discount configuration for plan components.

    This endpoint allows updating discount thresholds and rates for multiple
    plan components in a single request. Discounts are applied automatically
    when limit quantities meet or exceed the threshold.

    The discount configuration affects future billing:
    - Creates separate invoice items showing the discount.
    - Can be enabled or disabled per component.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/marketplace-plans/a1b2c3d4-e5f6-7890-abcd-ef1234567890/update_discounts/ \
  Authorization:"Token YOUR_API_TOKEN" \
  discounts:='{}'

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.discounts_update_request import DiscountsUpdateRequest # (1)
from waldur_api_client.api.marketplace_plans import marketplace_plans_update_discounts # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = DiscountsUpdateRequest(
    discounts={}
)
response = marketplace_plans_update_discounts.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: DiscountsUpdateRequest
  2. API Source: marketplace_plans_update_discounts
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { marketplacePlansUpdateDiscounts } from 'waldur-js-client';

try {
  const response = await marketplacePlansUpdateDiscounts({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "discounts": {}
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
discounts object (free-form) ✓ Dictionary mapping component types to their discount configuration.

200 - No response body

Update organization groups for a plan

Sets the list of organization groups that are allowed to access this plan. If the list is empty, the plan is accessible to all.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-plans/a1b2c3d4-e5f6-7890-abcd-ef1234567890/update_organization_groups/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.organization_groups_request import OrganizationGroupsRequest # (1)
from waldur_api_client.api.marketplace_plans import marketplace_plans_update_organization_groups # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OrganizationGroupsRequest()
response = marketplace_plans_update_organization_groups.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OrganizationGroupsRequest
  2. API Source: marketplace_plans_update_organization_groups
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplacePlansUpdateOrganizationGroups } from 'waldur-js-client';

try {
  const response = await marketplacePlansUpdateOrganizationGroups({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
organization_groups array of string (uri)s

200 - No response body

Update plan component prices

Updates the prices for one or more components of a specific plan. If the plan is already in use by resources, this action updates the future_price, which will be applied from the next billing period. Otherwise, the current price is updated directly.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/marketplace-plans/a1b2c3d4-e5f6-7890-abcd-ef1234567890/update_prices/ \
  Authorization:"Token YOUR_API_TOKEN" \
  prices:='{}'

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.prices_update_request import PricesUpdateRequest # (1)
from waldur_api_client.api.marketplace_plans import marketplace_plans_update_prices # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PricesUpdateRequest(
    prices={}
)
response = marketplace_plans_update_prices.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PricesUpdateRequest
  2. API Source: marketplace_plans_update_prices
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { marketplacePlansUpdatePrices } from 'waldur-js-client';

try {
  const response = await marketplacePlansUpdatePrices({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "prices": {}
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
prices object (free-form) ✓

200 - No response body

Update plan component quotas

Updates the quotas (fixed amounts) for one or more components of a specific plan. This is only applicable for components with a 'fixed-price' billing type.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/marketplace-plans/a1b2c3d4-e5f6-7890-abcd-ef1234567890/update_quotas/ \
  Authorization:"Token YOUR_API_TOKEN" \
  quotas:='{}'

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.quotas_update_request import QuotasUpdateRequest # (1)
from waldur_api_client.api.marketplace_plans import marketplace_plans_update_quotas # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = QuotasUpdateRequest(
    quotas={}
)
response = marketplace_plans_update_quotas.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: QuotasUpdateRequest
  2. API Source: marketplace_plans_update_quotas
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { marketplacePlansUpdateQuotas } from 'waldur-js-client';

try {
  const response = await marketplacePlansUpdateQuotas({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "quotas": {}
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
quotas object (free-form) ✓ Dictionary of quotas to update

200 - No response body

Update a provider plan

Updates an existing plan. Note: A plan cannot be updated if it is already used by resources.

1
2
3
4
5
6
http \
  PUT \
  https://api.example.com/api/marketplace-plans/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-marketplace-plan" \
  offering="https://api.example.com/api/offering/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.provider_plan_details_request import ProviderPlanDetailsRequest # (1)
from waldur_api_client.api.marketplace_plans import marketplace_plans_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ProviderPlanDetailsRequest(
    name="my-awesome-marketplace-plan",
    offering="https://api.example.com/api/offering/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = marketplace_plans_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ProviderPlanDetailsRequest
  2. API Source: marketplace_plans_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { marketplacePlansUpdate } from 'waldur-js-client';

try {
  const response = await marketplacePlansUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-marketplace-plan",
    "offering": "https://api.example.com/api/offering/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
name string ✓
description string
article_code string
max_amount integer Maximum number of plans that could be active. Plan is disabled when maximum amount is reached.
archived boolean Forbids creation of new resources.
unit_price string (decimal)
unit string
Enum: month, quarter, half_month, day, hour, quantity
backend_id string
offering string (uri) ✓

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
article_code string
max_amount integer Maximum number of plans that could be active. Plan is disabled when maximum amount is reached.
archived boolean Forbids creation of new resources.
is_active boolean
unit_price string (decimal)
unit string
Enum: month, quarter, half_month, day, hour, quantity
init_price number (double)
switch_price number (double)
backend_id string
organization_groups array of objects
organization_groups.uuid string (uuid)
organization_groups.url string (uri)
organization_groups.name string
organization_groups.parent_uuid string (uuid) UUID of the parent organization group
organization_groups.parent_name string Name of the parent organization group
organization_groups.parent string (uri)
organization_groups.customers_count integer Number of customers in this organization group
components array of objects
components.type string Unique internal name of the measured unit, for example floating_ip.
components.name string Display name for the measured unit, for example, Floating IP.
components.measured_unit string Unit of measurement, for example, GB.
components.amount integer
components.price string (decimal)
components.future_price string (decimal)
components.discount_threshold integer Minimum amount to be eligible for discount.
components.discount_rate integer Discount rate in percentage.
offering string (uri)
prices object (free-form)
future_prices object (free-form)
quotas object (free-form)
resources_count integer
plan_type string
minimal_price number (double)

Partially update a provider plan

Partially updates an existing plan. Note: A plan cannot be updated if it is already used by resources.

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/marketplace-plans/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_provider_plan_details_request import PatchedProviderPlanDetailsRequest # (1)
from waldur_api_client.api.marketplace_plans import marketplace_plans_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedProviderPlanDetailsRequest()
response = marketplace_plans_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedProviderPlanDetailsRequest
  2. API Source: marketplace_plans_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplacePlansPartialUpdate } from 'waldur-js-client';

try {
  const response = await marketplacePlansPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
name string
description string
article_code string
max_amount integer Maximum number of plans that could be active. Plan is disabled when maximum amount is reached.
archived boolean Forbids creation of new resources.
unit_price string (decimal)
unit string
Enum: month, quarter, half_month, day, hour, quantity
backend_id string

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
article_code string
max_amount integer Maximum number of plans that could be active. Plan is disabled when maximum amount is reached.
archived boolean Forbids creation of new resources.
is_active boolean
unit_price string (decimal)
unit string
Enum: month, quarter, half_month, day, hour, quantity
init_price number (double)
switch_price number (double)
backend_id string
organization_groups array of objects
organization_groups.uuid string (uuid)
organization_groups.url string (uri)
organization_groups.name string
organization_groups.parent_uuid string (uuid) UUID of the parent organization group
organization_groups.parent_name string Name of the parent organization group
organization_groups.parent string (uri)
organization_groups.customers_count integer Number of customers in this organization group
components array of objects
components.type string Unique internal name of the measured unit, for example floating_ip.
components.name string Display name for the measured unit, for example, Floating IP.
components.measured_unit string Unit of measurement, for example, GB.
components.amount integer
components.price string (decimal)
components.future_price string (decimal)
components.discount_threshold integer Minimum amount to be eligible for discount.
components.discount_rate integer Discount rate in percentage.
offering string (uri)
prices object (free-form)
future_prices object (free-form)
quotas object (free-form)
resources_count integer
plan_type string
minimal_price number (double)

Delete a provider plan

Deletes a plan. This is a hard delete and should be used with caution.

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/marketplace-plans/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_plans import marketplace_plans_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_plans_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_plans_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplacePlansDestroy } from 'waldur-js-client';

try {
  const response = await marketplacePlansDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Other Actions

Get object state at a specific timestamp

Returns the state of the object as it was at the specified timestamp. Only accessible by staff and support users.

1
2
3
4
5
http \
  GET \
  https://api.example.com/api/marketplace-plans/a1b2c3d4-e5f6-7890-abcd-ef1234567890/history/at/ \
  Authorization:"Token YOUR_API_TOKEN" \
  timestamp=="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_plans import marketplace_plans_history_at_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_plans_history_at_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    timestamp="string-value"
)

print(response)
  1. API Source: marketplace_plans_history_at_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { marketplacePlansHistoryAtRetrieve } from 'waldur-js-client';

try {
  const response = await marketplacePlansHistoryAtRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  query: {
    "timestamp": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type Required Description
timestamp string ✓ ISO 8601 timestamp to query the object state at

200 -

Field Type Description
id integer Version ID
revision_date string (date-time) When this revision was created
revision_user object (free-form) User who created this revision
revision_comment string Comment describing the revision
serialized_data object (free-form) Serialized model fields at this revision

400 -

404 -

Get version history

Returns the version history for this object. Only accessible by staff and support users.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-plans/a1b2c3d4-e5f6-7890-abcd-ef1234567890/history/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_plans import marketplace_plans_history_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_plans_history_list.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

for item in response:
    print(item)
  1. API Source: marketplace_plans_history_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplacePlansHistoryList } from 'waldur-js-client';

try {
  const response = await marketplacePlansHistoryList({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type Description
created_after string Filter versions created after this timestamp (ISO 8601)
created_before string Filter versions created before this timestamp (ISO 8601)
offering string (uri)
offering_slug array Multiple values may be separated by commas.
offering_uuid string (uuid) Offering UUID
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
parent_offering_uuid string (uuid)

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
id integer Version ID
revision_date string (date-time) When this revision was created
revision_user object (free-form) User who created this revision
revision_comment string Comment describing the revision
serialized_data object (free-form) Serialized model fields at this revision

Get plan usage statistics

Returns aggregated statistics on how many resources are currently using each plan. Can be filtered by offering or service provider.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-plans/usage_stats/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_plans import marketplace_plans_usage_stats_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_plans_usage_stats_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: marketplace_plans_usage_stats_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplacePlansUsageStatsList } from 'waldur-js-client';

try {
  const response = await marketplacePlansUsageStatsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
customer_provider_uuid string (uuid) Filter by offering customer provider UUID.
o string Ordering field. Available options: usage, limit, remaining, and their descending counterparts (e.g., -usage).
offering string (uri)
offering_slug array Multiple values may be separated by commas.
offering_uuid string (uuid) Filter by offering UUID.
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
parent_offering_uuid string (uuid)

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
plan_uuid string (uuid) UUID of the plan
plan_name string Name of the plan
limit integer Usage limit
usage integer Current usage count
remaining integer Remaining usage
offering_uuid string (uuid)
offering_name string
customer_provider_uuid string (uuid)
customer_provider_name string

Archive a plan

Marks a plan as archived. Archived plans cannot be used for provisioning new resources, but existing resources will continue to be billed according to this plan.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-plans/a1b2c3d4-e5f6-7890-abcd-ef1234567890/archive/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_plans import marketplace_plans_archive # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_plans_archive.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_plans_archive
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplacePlansArchive } from 'waldur-js-client';

try {
  const response = await marketplacePlansArchive({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 - No response body

Remove all organization groups from a plan

Removes all organization group associations from this plan, making it accessible to all users (subject to offering-level restrictions).

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-plans/a1b2c3d4-e5f6-7890-abcd-ef1234567890/delete_organization_groups/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_plans import marketplace_plans_delete_organization_groups # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_plans_delete_organization_groups.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_plans_delete_organization_groups
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplacePlansDeleteOrganizationGroups } from 'waldur-js-client';

try {
  const response = await marketplacePlansDeleteOrganizationGroups({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Marketplace Public Offerings

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/marketplace-public-offerings/ List public offerings
GET /api/marketplace-public-offerings/{uuid}/ Retrieve a public offering
Other Actions
GET /api/marketplace-public-offerings/{uuid}/plans/ List plans for an offering
GET /api/marketplace-public-offerings/{uuid}/plans/{plan_uuid}/ Retrieve a specific plan for an offering

Core CRUD

List public offerings

Returns a paginated list of public offerings. The list is filtered to show only offerings that are active or paused and available for ordering by the current user. If anonymous access is enabled, it shows shared offerings available to unauthenticated users.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-public-offerings/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.offering_state import OfferingState # (1)
from waldur_api_client.models.provider_offering_details_o_enum import ProviderOfferingDetailsOEnum # (2)
from waldur_api_client.models.public_offering_details_field_enum import PublicOfferingDetailsFieldEnum # (3)
from waldur_api_client.api.marketplace_public_offerings import marketplace_public_offerings_list # (4)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_public_offerings_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: OfferingState
  2. Model Source: ProviderOfferingDetailsOEnum
  3. Model Source: PublicOfferingDetailsFieldEnum
  4. API Source: marketplace_public_offerings_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplacePublicOfferingsList } from 'waldur-js-client';

try {
  const response = await marketplacePublicOfferingsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
accessible_via_calls boolean Accessible via calls
allowed_customer_uuid string (uuid) Allowed customer UUID
attributes string Offering attributes (JSON)
billable boolean Billable
can_create_offering_user boolean
category_group_uuid string (uuid) Category group UUID
category_uuid string (uuid) Category UUID
created string (date-time) Created after
customer string (uri) Customer URL
customer_uuid string (uuid) Customer UUID
description string Description contains
field array
has_active_terms_of_service boolean Has Active Terms of Service
has_terms_of_service boolean Has Terms of Service
keyword string Keyword
modified string (date-time) Modified after
name string Name
name_exact string Name (exact)
o array Ordering
organization_group_uuid string (uuid) Organization group UUID
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
parent_uuid string (uuid) Parent offering UUID
project_uuid string (uuid) Project UUID
query string Search by offering name, slug or description
resource_customer_uuid string (uuid) Resource customer UUID
resource_project_uuid string (uuid) Resource project UUID
scope_uuid string Scope UUID
service_manager_uuid string (uuid) Service manager UUID
shared boolean Shared
state array Offering state
tag array Tag UUID (OR logic)
tag_name array Tag name (OR logic)
tag_names_and string Tag names with AND logic (comma-separated)
tags_and string Tag UUIDs with AND logic (comma-separated)
type array Offering type
user_has_consent boolean User Has Consent
user_has_offering_user boolean User Has Offering User
uuid_list string Comma-separated offering UUIDs

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
created string (date-time)
name string
slug string URL-friendly identifier. Only editable by staff users.
description string
full_description string
privacy_policy_link string (uri)
access_url string (uri) Publicly accessible offering access URL
endpoints array of objects
endpoints.uuid string (uuid)
endpoints.name string
endpoints.url string URL of the access endpoint
software_catalogs array of objects
software_catalogs.uuid string (uuid)
software_catalogs.catalog any
software_catalogs.enabled_cpu_family any List of enabled CPU families: ['x86_64', 'aarch64']
software_catalogs.enabled_cpu_microarchitectures any List of enabled CPU microarchitectures: ['generic', 'zen3']
software_catalogs.package_count integer
software_catalogs.partition any
partitions array of objects
partitions.uuid string (uuid)
partitions.partition_name string Name of the SLURM partition
partitions.cpu_bind integer Default task binding policy (SLURM cpu_bind)
partitions.def_cpu_per_gpu integer Default CPUs allocated per GPU
partitions.max_cpus_per_node integer Maximum allocated CPUs per node
partitions.max_cpus_per_socket integer Maximum allocated CPUs per socket
partitions.def_mem_per_cpu integer (int64) Default memory per CPU in MB
partitions.def_mem_per_gpu integer (int64) Default memory per GPU in MB
partitions.def_mem_per_node integer (int64) Default memory per node in MB
partitions.max_mem_per_cpu integer (int64) Maximum memory per CPU in MB
partitions.max_mem_per_node integer (int64) Maximum memory per node in MB
partitions.default_time integer Default time limit in minutes
partitions.max_time integer Maximum time limit in minutes
partitions.grace_time integer Preemption grace time in seconds
partitions.max_nodes integer Maximum nodes per job
partitions.min_nodes integer Minimum nodes per job
partitions.exclusive_topo boolean Exclusive topology access required
partitions.exclusive_user boolean Exclusive user access required
partitions.priority_tier integer Priority tier for scheduling and preemption
partitions.qos string Quality of Service (QOS) name
partitions.req_resv boolean Require reservation for job allocation
roles array of objects
roles.uuid string (uuid)
roles.name string
roles.url string (uri)
customer string (uri)
customer_uuid string (uuid)
customer_name string
project string (uri)
project_uuid string (uuid)
project_name string
category string (uri)
category_uuid string (uuid)
category_title string
attributes object (free-form)
options any
resource_options any
components array of objects
components.uuid string (uuid)
components.billing_type string
Enum: fixed, usage, limit, one, few
components.type string Unique internal name of the measured unit, for example floating_ip.
components.name string Display name for the measured unit, for example, Floating IP.
components.description string
components.measured_unit string Unit of measurement, for example, GB.
components.unit_factor integer The conversion factor from backend units to measured_unit
components.limit_period any
components.limit_amount integer
components.article_code string
components.max_value integer
components.min_value integer
components.max_available_limit integer
components.is_boolean boolean
components.default_limit integer
components.factor integer
components.is_builtin boolean
components.is_prepaid boolean
components.overage_component string (uuid)
components.min_prepaid_duration integer
components.max_prepaid_duration integer
plugin_options any
state any
vendor_details string
getting_started string
integration_guide string
thumbnail string (uri)
order_count integer
plans array of objects
plans.url string (uri)
plans.uuid string (uuid)
plans.name string
plans.description string
plans.article_code string
plans.max_amount integer Maximum number of plans that could be active. Plan is disabled when maximum amount is reached.
plans.archived boolean Forbids creation of new resources.
plans.is_active boolean
plans.unit_price string (decimal)
plans.unit string
Enum: month, quarter, half_month, day, hour, quantity
plans.init_price number (double)
plans.switch_price number (double)
plans.backend_id string
plans.organization_groups array of objects
plans.organization_groups.uuid string (uuid)
plans.organization_groups.url string (uri)
plans.organization_groups.name string
plans.organization_groups.parent_uuid string (uuid) UUID of the parent organization group
plans.organization_groups.parent_name string Name of the parent organization group
plans.organization_groups.parent string (uri)
plans.organization_groups.customers_count integer Number of customers in this organization group
plans.components array of objects
plans.components.type string Unique internal name of the measured unit, for example floating_ip.
plans.components.name string Display name for the measured unit, for example, Floating IP.
plans.components.measured_unit string Unit of measurement, for example, GB.
plans.components.amount integer
plans.components.price string (decimal)
plans.components.future_price string (decimal)
plans.components.discount_threshold integer Minimum amount to be eligible for discount.
plans.components.discount_rate integer Discount rate in percentage.
plans.prices object (free-form)
plans.future_prices object (free-form)
plans.quotas object (free-form)
plans.resources_count integer
plans.plan_type string
plans.minimal_price number (double)
screenshots array of objects
screenshots.name string
screenshots.uuid string (uuid)
screenshots.description string
screenshots.image string (uri)
screenshots.thumbnail string (uri)
screenshots.created string (date-time)
type string
shared boolean Accessible to all customers.
billable boolean Purchase and usage is invoiced.
scope string
scope_uuid string (uuid)
scope_name string (uuid)
scope_state any
scope_error_message string
files array of objects
files.name string
files.created string (date-time)
files.file string (uri)
quotas array of objects
quotas.name string
quotas.usage integer
quotas.limit integer
paused_reason string
datacite_doi string
citation_count integer Number of citations of a DOI
latitude number (double)
longitude number (double)
country any Country code (ISO 3166-1 alpha-2)
backend_id string
organization_groups array of objects
organization_groups.uuid string (uuid)
organization_groups.url string (uri)
organization_groups.name string
organization_groups.parent_uuid string (uuid) UUID of the parent organization group
organization_groups.parent_name string Name of the parent organization group
organization_groups.parent string (uri)
organization_groups.customers_count integer Number of customers in this organization group
tags array of objects
tags.uuid string (uuid)
tags.name string
image string (uri)
total_customers integer
total_cost integer
total_cost_estimated integer
parent_description string
parent_uuid string (uuid)
parent_name string
backend_metadata any
has_compliance_requirements boolean
billing_type_classification string Classify offering components by billing type. Returns 'limit_only', 'usage_only', or 'mixed'.
compliance_checklist string (uri)
user_has_consent boolean
is_accessible boolean
google_calendar_is_public boolean
google_calendar_link string Get the Google Calendar link for an offering.
promotion_campaigns array of objects
promotion_campaigns.uuid string (uuid)
promotion_campaigns.name string
promotion_campaigns.start_date string (date) Starting from this date, the campaign is active.
promotion_campaigns.end_date string (date) The last day the campaign is active.
promotion_campaigns.discount_type string
Enum: discount, special_price
promotion_campaigns.discount integer
promotion_campaigns.stock integer
promotion_campaigns.description string
promotion_campaigns.months integer How many months in a row should the related service (when activated) get special deal (0 for indefinitely until active)
promotion_campaigns.service_provider string (uri)

Retrieve a public offering

Returns the details of a specific public offering. Access is granted if the offering is available for ordering by the current user or if anonymous access is enabled.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-public-offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.public_offering_details_field_enum import PublicOfferingDetailsFieldEnum # (1)
from waldur_api_client.api.marketplace_public_offerings import marketplace_public_offerings_retrieve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_public_offerings_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. Model Source: PublicOfferingDetailsFieldEnum
  2. API Source: marketplace_public_offerings_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplacePublicOfferingsRetrieve } from 'waldur-js-client';

try {
  const response = await marketplacePublicOfferingsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type
field array

200 -

Field Type Description
url string (uri)
uuid string (uuid)
created string (date-time)
name string
slug string URL-friendly identifier. Only editable by staff users.
description string
full_description string
privacy_policy_link string (uri)
access_url string (uri) Publicly accessible offering access URL
endpoints array of objects
endpoints.uuid string (uuid)
endpoints.name string
endpoints.url string URL of the access endpoint
software_catalogs array of objects
software_catalogs.uuid string (uuid)
software_catalogs.catalog any
software_catalogs.enabled_cpu_family any List of enabled CPU families: ['x86_64', 'aarch64']
software_catalogs.enabled_cpu_microarchitectures any List of enabled CPU microarchitectures: ['generic', 'zen3']
software_catalogs.package_count integer
software_catalogs.partition any
partitions array of objects
partitions.uuid string (uuid)
partitions.partition_name string Name of the SLURM partition
partitions.cpu_bind integer Default task binding policy (SLURM cpu_bind)
partitions.def_cpu_per_gpu integer Default CPUs allocated per GPU
partitions.max_cpus_per_node integer Maximum allocated CPUs per node
partitions.max_cpus_per_socket integer Maximum allocated CPUs per socket
partitions.def_mem_per_cpu integer (int64) Default memory per CPU in MB
partitions.def_mem_per_gpu integer (int64) Default memory per GPU in MB
partitions.def_mem_per_node integer (int64) Default memory per node in MB
partitions.max_mem_per_cpu integer (int64) Maximum memory per CPU in MB
partitions.max_mem_per_node integer (int64) Maximum memory per node in MB
partitions.default_time integer Default time limit in minutes
partitions.max_time integer Maximum time limit in minutes
partitions.grace_time integer Preemption grace time in seconds
partitions.max_nodes integer Maximum nodes per job
partitions.min_nodes integer Minimum nodes per job
partitions.exclusive_topo boolean Exclusive topology access required
partitions.exclusive_user boolean Exclusive user access required
partitions.priority_tier integer Priority tier for scheduling and preemption
partitions.qos string Quality of Service (QOS) name
partitions.req_resv boolean Require reservation for job allocation
roles array of objects
roles.uuid string (uuid)
roles.name string
roles.url string (uri)
customer string (uri)
customer_uuid string (uuid)
customer_name string
project string (uri)
project_uuid string (uuid)
project_name string
category string (uri)
category_uuid string (uuid)
category_title string
attributes object (free-form)
options any
resource_options any
components array of objects
components.uuid string (uuid)
components.billing_type string
Enum: fixed, usage, limit, one, few
components.type string Unique internal name of the measured unit, for example floating_ip.
components.name string Display name for the measured unit, for example, Floating IP.
components.description string
components.measured_unit string Unit of measurement, for example, GB.
components.unit_factor integer The conversion factor from backend units to measured_unit
components.limit_period any
components.limit_amount integer
components.article_code string
components.max_value integer
components.min_value integer
components.max_available_limit integer
components.is_boolean boolean
components.default_limit integer
components.factor integer
components.is_builtin boolean
components.is_prepaid boolean
components.overage_component string (uuid)
components.min_prepaid_duration integer
components.max_prepaid_duration integer
plugin_options any
state any
vendor_details string
getting_started string
integration_guide string
thumbnail string (uri)
order_count integer
plans array of objects
plans.url string (uri)
plans.uuid string (uuid)
plans.name string
plans.description string
plans.article_code string
plans.max_amount integer Maximum number of plans that could be active. Plan is disabled when maximum amount is reached.
plans.archived boolean Forbids creation of new resources.
plans.is_active boolean
plans.unit_price string (decimal)
plans.unit string
Enum: month, quarter, half_month, day, hour, quantity
plans.init_price number (double)
plans.switch_price number (double)
plans.backend_id string
plans.organization_groups array of objects
plans.organization_groups.uuid string (uuid)
plans.organization_groups.url string (uri)
plans.organization_groups.name string
plans.organization_groups.parent_uuid string (uuid) UUID of the parent organization group
plans.organization_groups.parent_name string Name of the parent organization group
plans.organization_groups.parent string (uri)
plans.organization_groups.customers_count integer Number of customers in this organization group
plans.components array of objects
plans.components.type string Unique internal name of the measured unit, for example floating_ip.
plans.components.name string Display name for the measured unit, for example, Floating IP.
plans.components.measured_unit string Unit of measurement, for example, GB.
plans.components.amount integer
plans.components.price string (decimal)
plans.components.future_price string (decimal)
plans.components.discount_threshold integer Minimum amount to be eligible for discount.
plans.components.discount_rate integer Discount rate in percentage.
plans.prices object (free-form)
plans.future_prices object (free-form)
plans.quotas object (free-form)
plans.resources_count integer
plans.plan_type string
plans.minimal_price number (double)
screenshots array of objects
screenshots.name string
screenshots.uuid string (uuid)
screenshots.description string
screenshots.image string (uri)
screenshots.thumbnail string (uri)
screenshots.created string (date-time)
type string
shared boolean Accessible to all customers.
billable boolean Purchase and usage is invoiced.
scope string
scope_uuid string (uuid)
scope_name string (uuid)
scope_state any
scope_error_message string
files array of objects
files.name string
files.created string (date-time)
files.file string (uri)
quotas array of objects
quotas.name string
quotas.usage integer
quotas.limit integer
paused_reason string
datacite_doi string
citation_count integer Number of citations of a DOI
latitude number (double)
longitude number (double)
country any Country code (ISO 3166-1 alpha-2)
backend_id string
organization_groups array of objects
organization_groups.uuid string (uuid)
organization_groups.url string (uri)
organization_groups.name string
organization_groups.parent_uuid string (uuid) UUID of the parent organization group
organization_groups.parent_name string Name of the parent organization group
organization_groups.parent string (uri)
organization_groups.customers_count integer Number of customers in this organization group
tags array of objects
tags.uuid string (uuid)
tags.name string
image string (uri)
total_customers integer
total_cost integer
total_cost_estimated integer
parent_description string
parent_uuid string (uuid)
parent_name string
backend_metadata any
has_compliance_requirements boolean
billing_type_classification string Classify offering components by billing type. Returns 'limit_only', 'usage_only', or 'mixed'.
compliance_checklist string (uri)
user_has_consent boolean
is_accessible boolean
google_calendar_is_public boolean
google_calendar_link string Get the Google Calendar link for an offering.
promotion_campaigns array of objects
promotion_campaigns.uuid string (uuid)
promotion_campaigns.name string
promotion_campaigns.start_date string (date) Starting from this date, the campaign is active.
promotion_campaigns.end_date string (date) The last day the campaign is active.
promotion_campaigns.discount_type string
Enum: discount, special_price
promotion_campaigns.discount integer
promotion_campaigns.stock integer
promotion_campaigns.description string
promotion_campaigns.months integer How many months in a row should the related service (when activated) get special deal (0 for indefinitely until active)
promotion_campaigns.service_provider string (uri)

Other Actions

List plans for an offering

Returns a list of plans available for a specific offering. The plans are filtered based on the current user's permissions and organization group memberships.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-public-offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/plans/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_public_offerings import marketplace_public_offerings_plans_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_public_offerings_plans_list.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

for item in response:
    print(item)
  1. API Source: marketplace_public_offerings_plans_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplacePublicOfferingsPlansList } from 'waldur-js-client';

try {
  const response = await marketplacePublicOfferingsPlansList({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
article_code string
max_amount integer Maximum number of plans that could be active. Plan is disabled when maximum amount is reached.
archived boolean Forbids creation of new resources.
is_active boolean
unit_price string (decimal)
unit string
Enum: month, quarter, half_month, day, hour, quantity
init_price number (double)
switch_price number (double)
backend_id string
organization_groups array of objects
organization_groups.uuid string (uuid)
organization_groups.url string (uri)
organization_groups.name string
organization_groups.parent_uuid string (uuid) UUID of the parent organization group
organization_groups.parent_name string Name of the parent organization group
organization_groups.parent string (uri)
organization_groups.customers_count integer Number of customers in this organization group
components array of objects
components.type string Unique internal name of the measured unit, for example floating_ip.
components.name string Display name for the measured unit, for example, Floating IP.
components.measured_unit string Unit of measurement, for example, GB.
components.amount integer
components.price string (decimal)
components.future_price string (decimal)
components.discount_threshold integer Minimum amount to be eligible for discount.
components.discount_rate integer Discount rate in percentage.
prices object (free-form)
future_prices object (free-form)
quotas object (free-form)
resources_count integer
plan_type string
minimal_price number (double)

Retrieve a specific plan for an offering

Returns the details of a specific plan if it is available to the current user for the given offering.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-public-offerings/string-value/plans/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_public_offerings import marketplace_public_offerings_plans_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_public_offerings_plans_retrieve.sync(
    plan_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    uuid="string-value",
    client=client
)

print(response)
  1. API Source: marketplace_public_offerings_plans_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { marketplacePublicOfferingsPlansRetrieve } from 'waldur-js-client';

try {
  const response = await marketplacePublicOfferingsPlansRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "plan_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "uuid": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
plan_uuid string ✓
uuid string ✓

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
article_code string
max_amount integer Maximum number of plans that could be active. Plan is disabled when maximum amount is reached.
archived boolean Forbids creation of new resources.
is_active boolean
unit_price string (decimal)
unit string
Enum: month, quarter, half_month, day, hour, quantity
init_price number (double)
switch_price number (double)
backend_id string
organization_groups array of objects
organization_groups.uuid string (uuid)
organization_groups.url string (uri)
organization_groups.name string
organization_groups.parent_uuid string (uuid) UUID of the parent organization group
organization_groups.parent_name string Name of the parent organization group
organization_groups.parent string (uri)
organization_groups.customers_count integer Number of customers in this organization group
components array of objects
components.type string Unique internal name of the measured unit, for example floating_ip.
components.name string Display name for the measured unit, for example, Floating IP.
components.measured_unit string Unit of measurement, for example, GB.
components.amount integer
components.price string (decimal)
components.future_price string (decimal)
components.discount_threshold integer Minimum amount to be eligible for discount.
components.discount_rate integer Discount rate in percentage.
prices object (free-form)
future_prices object (free-form)
quotas object (free-form)
resources_count integer
plan_type string
minimal_price number (double)

Marketplace Resource Offerings

Operations Summary

Method Endpoint Description
GET /api/marketplace-resource-offerings/{category_uuid}/ Retrieve

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-resource-offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_resource_offerings import marketplace_resource_offerings_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_resource_offerings_list.sync(
    category_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

for item in response:
    print(item)
  1. API Source: marketplace_resource_offerings_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceResourceOfferingsList } from 'waldur-js-client';

try {
  const response = await marketplaceResourceOfferingsList({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "category_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
category_uuid string ✓
Name Type Description
name string Name
name_exact string Name (exact)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
name string
uuid string (uuid)

Marketplace Screenshots

Operations Summary

Method Endpoint Description
GET /api/marketplace-screenshots/ List Marketplace Screenshots
GET /api/marketplace-screenshots/{uuid}/ Retrieve
POST /api/marketplace-screenshots/ Create
PUT /api/marketplace-screenshots/{uuid}/ Update
PATCH /api/marketplace-screenshots/{uuid}/ Partial Update
DELETE /api/marketplace-screenshots/{uuid}/ Delete

List Marketplace Screenshots

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-screenshots/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.maintenance_announcement_template_o_enum import MaintenanceAnnouncementTemplateOEnum # (1)
from waldur_api_client.api.marketplace_screenshots import marketplace_screenshots_list # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_screenshots_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: MaintenanceAnnouncementTemplateOEnum
  2. API Source: marketplace_screenshots_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceScreenshotsList } from 'waldur-js-client';

try {
  const response = await marketplaceScreenshotsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
o array Ordering
offering string (uri)
offering_slug array Multiple values may be separated by commas.
offering_uuid array Multiple values may be separated by commas.
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
parent_offering_uuid string (uuid)

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
url string (uri)
uuid string (uuid)
name string
created string (date-time)
description string
image string (uri)
thumbnail string (uri)
offering string (uri)
customer_uuid string (uuid)

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-screenshots/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_screenshots import marketplace_screenshots_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_screenshots_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_screenshots_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceScreenshotsRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceScreenshotsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
url string (uri)
uuid string (uuid)
name string
created string (date-time)
description string
image string (uri)
thumbnail string (uri)
offering string (uri)
customer_uuid string (uuid)

Create

1
2
3
4
5
6
7
http \
  POST \
  https://api.example.com/api/marketplace-screenshots/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-marketplace-screenshot" \
  image="string-value" \
  offering="https://api.example.com/api/offering/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.screenshot_request import ScreenshotRequest # (1)
from waldur_api_client.api.marketplace_screenshots import marketplace_screenshots_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ScreenshotRequest(
    name="my-awesome-marketplace-screenshot",
    image="string-value",
    offering="https://api.example.com/api/offering/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = marketplace_screenshots_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ScreenshotRequest
  2. API Source: marketplace_screenshots_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
import { marketplaceScreenshotsCreate } from 'waldur-js-client';

try {
  const response = await marketplaceScreenshotsCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "name": "my-awesome-marketplace-screenshot",
    "image": "string-value",
    "offering": "https://api.example.com/api/offering/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required
name string ✓
description string
image string (binary) ✓
offering string (uri) ✓

201 -

Field Type
url string (uri)
uuid string (uuid)
name string
created string (date-time)
description string
image string (uri)
thumbnail string (uri)
offering string (uri)
customer_uuid string (uuid)

Update

1
2
3
4
5
6
7
http \
  PUT \
  https://api.example.com/api/marketplace-screenshots/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-marketplace-screenshot" \
  image="string-value" \
  offering="https://api.example.com/api/offering/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.screenshot_request import ScreenshotRequest # (1)
from waldur_api_client.api.marketplace_screenshots import marketplace_screenshots_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ScreenshotRequest(
    name="my-awesome-marketplace-screenshot",
    image="string-value",
    offering="https://api.example.com/api/offering/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = marketplace_screenshots_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ScreenshotRequest
  2. API Source: marketplace_screenshots_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
import { marketplaceScreenshotsUpdate } from 'waldur-js-client';

try {
  const response = await marketplaceScreenshotsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-marketplace-screenshot",
    "image": "string-value",
    "offering": "https://api.example.com/api/offering/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
name string ✓
description string
image string (binary) ✓
offering string (uri) ✓

200 -

Field Type
url string (uri)
uuid string (uuid)
name string
created string (date-time)
description string
image string (uri)
thumbnail string (uri)
offering string (uri)
customer_uuid string (uuid)

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/marketplace-screenshots/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_screenshot_request import PatchedScreenshotRequest # (1)
from waldur_api_client.api.marketplace_screenshots import marketplace_screenshots_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedScreenshotRequest()
response = marketplace_screenshots_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedScreenshotRequest
  2. API Source: marketplace_screenshots_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceScreenshotsPartialUpdate } from 'waldur-js-client';

try {
  const response = await marketplaceScreenshotsPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
name string
description string

200 -

Field Type
url string (uri)
uuid string (uuid)
name string
created string (date-time)
description string
image string (uri)
thumbnail string (uri)
offering string (uri)
customer_uuid string (uuid)

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/marketplace-screenshots/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_screenshots import marketplace_screenshots_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_screenshots_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_screenshots_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceScreenshotsDestroy } from 'waldur-js-client';

try {
  const response = await marketplaceScreenshotsDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Service Settings

Operations Summary

Method Endpoint Description
GET /api/service-settings/ List Service Settings
GET /api/service-settings/{uuid}/ Retrieve

List Service Settings

1
2
3
4
http \
  GET \
  https://api.example.com/api/service-settings/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.core_states import CoreStates # (1)
from waldur_api_client.models.service_settings_field_enum import ServiceSettingsFieldEnum # (2)
from waldur_api_client.api.service_settings import service_settings_list # (3)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = service_settings_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: CoreStates
  2. Model Source: ServiceSettingsFieldEnum
  3. API Source: service_settings_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { serviceSettingsList } from 'waldur-js-client';

try {
  const response = await serviceSettingsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
customer string (uuid) Customer UUID
customer_uuid string (uuid) Customer UUID
field array
name string Name
name_exact string Name (exact)
o string Which field to use when ordering the results.
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
scope string (uri) Filter by scope URL.
scope_uuid string Scope UUID
shared boolean
state array State
type string Type

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
name string
type string
state any
error_message string
shared boolean Anybody can use it
customer string (uri)
customer_name string
customer_native_name string
terms_of_services string (uri)
scope string
scope_uuid string (uuid)
options object (free-form)

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.service_settings_field_enum import ServiceSettingsFieldEnum # (1)
from waldur_api_client.api.service_settings import service_settings_retrieve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = service_settings_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. Model Source: ServiceSettingsFieldEnum
  2. API Source: service_settings_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { serviceSettingsRetrieve } from 'waldur-js-client';

try {
  const response = await serviceSettingsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type
field array

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
type string
state any
error_message string
shared boolean Anybody can use it
customer string (uri)
customer_name string
customer_native_name string
terms_of_services string (uri)
scope string
scope_uuid string (uuid)
options object (free-form)

Marketplace Tags

Operations Summary

Method Endpoint Description
GET /api/marketplace-tags/ List Marketplace Tags
GET /api/marketplace-tags/{uuid}/ Retrieve
POST /api/marketplace-tags/ Create
PUT /api/marketplace-tags/{uuid}/ Update
PATCH /api/marketplace-tags/{uuid}/ Partial Update
DELETE /api/marketplace-tags/{uuid}/ Delete

List Marketplace Tags

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-tags/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_tags import marketplace_tags_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_tags_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: marketplace_tags_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceTagsList } from 'waldur-js-client';

try {
  const response = await marketplaceTagsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
created_by string (uuid)
name string
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
offering_count integer Return offering count filtered by user permissions. Staff sees all offerings. Service providers see their own + active/paused/archived public offerings.
created string (date-time)
created_by_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
created_by_full_name string

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-tags/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_tags import marketplace_tags_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_tags_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_tags_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceTagsRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceTagsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
offering_count integer Return offering count filtered by user permissions. Staff sees all offerings. Service providers see their own + active/paused/archived public offerings.
created string (date-time)
created_by_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
created_by_full_name string

Create

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/marketplace-tags/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-marketplace-tag"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.tag_request import TagRequest # (1)
from waldur_api_client.api.marketplace_tags import marketplace_tags_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = TagRequest(
    name="my-awesome-marketplace-tag"
)
response = marketplace_tags_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: TagRequest
  2. API Source: marketplace_tags_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceTagsCreate } from 'waldur-js-client';

try {
  const response = await marketplaceTagsCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "name": "my-awesome-marketplace-tag"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required
name string ✓
description string

201 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
offering_count integer Return offering count filtered by user permissions. Staff sees all offerings. Service providers see their own + active/paused/archived public offerings.
created string (date-time)
created_by_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
created_by_full_name string

Update

1
2
3
4
5
http \
  PUT \
  https://api.example.com/api/marketplace-tags/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-marketplace-tag"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.tag_request import TagRequest # (1)
from waldur_api_client.api.marketplace_tags import marketplace_tags_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = TagRequest(
    name="my-awesome-marketplace-tag"
)
response = marketplace_tags_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: TagRequest
  2. API Source: marketplace_tags_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { marketplaceTagsUpdate } from 'waldur-js-client';

try {
  const response = await marketplaceTagsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-marketplace-tag"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
name string ✓
description string

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
offering_count integer Return offering count filtered by user permissions. Staff sees all offerings. Service providers see their own + active/paused/archived public offerings.
created string (date-time)
created_by_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
created_by_full_name string

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/marketplace-tags/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_tag_request import PatchedTagRequest # (1)
from waldur_api_client.api.marketplace_tags import marketplace_tags_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedTagRequest()
response = marketplace_tags_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedTagRequest
  2. API Source: marketplace_tags_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceTagsPartialUpdate } from 'waldur-js-client';

try {
  const response = await marketplaceTagsPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
name string
description string

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
offering_count integer Return offering count filtered by user permissions. Staff sees all offerings. Service providers see their own + active/paused/archived public offerings.
created string (date-time)
created_by_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
created_by_full_name string

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/marketplace-tags/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_tags import marketplace_tags_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_tags_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_tags_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceTagsDestroy } from 'waldur-js-client';

try {
  const response = await marketplaceTagsDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Onboarding

Onboarding Justifications

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/onboarding-justifications/ List Onboarding Justifications
GET /api/onboarding-justifications/{uuid}/ Retrieve
POST /api/onboarding-justifications/ Create
POST /api/onboarding-justifications/create_justification/ Create justification for failed verification
PUT /api/onboarding-justifications/{uuid}/ Update
PATCH /api/onboarding-justifications/{uuid}/ Partial Update
DELETE /api/onboarding-justifications/{uuid}/ Delete
Other Actions
POST /api/onboarding-justifications/{uuid}/approve/ Approve justification and mark verification as VERIFIED
POST /api/onboarding-justifications/{uuid}/attach_document/ Attach supporting document to justification
POST /api/onboarding-justifications/{uuid}/reject/ Reject justification and mark verification as FAILED

Core CRUD

List Onboarding Justifications

1
2
3
4
http \
  GET \
  https://api.example.com/api/onboarding-justifications/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.onboarding_justification_o_enum import OnboardingJustificationOEnum # (1)
from waldur_api_client.models.onboarding_justification_validation_decision_enum import OnboardingJustificationValidationDecisionEnum # (2)
from waldur_api_client.api.onboarding_justifications import onboarding_justifications_list # (3)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = onboarding_justifications_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: OnboardingJustificationOEnum
  2. Model Source: OnboardingJustificationValidationDecisionEnum
  3. API Source: onboarding_justifications_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { onboardingJustificationsList } from 'waldur-js-client';

try {
  const response = await onboardingJustificationsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
o array Ordering
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
query string Filter by legal name, legal person identifier
user_uuid string (uuid) User UUID
validation_decision array Review decision
verification_uuid string (uuid) Verification UUID

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid)
verification string (uri)
verification_uuid string (uuid)
country string
user string (uri)
user_full_name string
legal_person_identifier string
legal_name string
error_message string
error_traceback string
user_justification string User's explanation for why they should be authorized
validated_by string (uri)
validated_at string (date-time)
validation_decision any
staff_notes string Administrator notes on the review decision
supporting_documentation array of objects
supporting_documentation.uuid string (uuid)
supporting_documentation.file string (uri) Upload supporting documentation.
supporting_documentation.file_name string
supporting_documentation.file_size integer
supporting_documentation.created string (date-time)
onboarding_metadata object (free-form) Onboarding-specific data like intents, purposes extracted from checklist answers
user_submitted_customer_data object (free-form) Customer-related data submitted by the user via checklist answers
created string (date-time)
modified string (date-time)

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/onboarding-justifications/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.onboarding_justifications import onboarding_justifications_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = onboarding_justifications_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: onboarding_justifications_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { onboardingJustificationsRetrieve } from 'waldur-js-client';

try {
  const response = await onboardingJustificationsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
uuid string (uuid)
verification string (uri)
verification_uuid string (uuid)
country string
user string (uri)
user_full_name string
legal_person_identifier string
legal_name string
error_message string
error_traceback string
user_justification string User's explanation for why they should be authorized
validated_by string (uri)
validated_at string (date-time)
validation_decision any
staff_notes string Administrator notes on the review decision
supporting_documentation array of objects
supporting_documentation.uuid string (uuid)
supporting_documentation.file string (uri) Upload supporting documentation.
supporting_documentation.file_name string
supporting_documentation.file_size integer
supporting_documentation.created string (date-time)
onboarding_metadata object (free-form) Onboarding-specific data like intents, purposes extracted from checklist answers
user_submitted_customer_data object (free-form) Customer-related data submitted by the user via checklist answers
created string (date-time)
modified string (date-time)

Create

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/onboarding-justifications/ \
  Authorization:"Token YOUR_API_TOKEN" \
  verification="https://api.example.com/api/verification/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.onboarding_justification_request import OnboardingJustificationRequest # (1)
from waldur_api_client.api.onboarding_justifications import onboarding_justifications_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OnboardingJustificationRequest(
    verification="https://api.example.com/api/verification/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = onboarding_justifications_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OnboardingJustificationRequest
  2. API Source: onboarding_justifications_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { onboardingJustificationsCreate } from 'waldur-js-client';

try {
  const response = await onboardingJustificationsCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "verification": "https://api.example.com/api/verification/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
verification string (uri) ✓
user_justification string User's explanation for why they should be authorized

201 -

Field Type Description
uuid string (uuid)
verification string (uri)
verification_uuid string (uuid)
country string
user string (uri)
user_full_name string
legal_person_identifier string
legal_name string
error_message string
error_traceback string
user_justification string User's explanation for why they should be authorized
validated_by string (uri)
validated_at string (date-time)
validation_decision any
staff_notes string Administrator notes on the review decision
supporting_documentation array of objects
supporting_documentation.uuid string (uuid)
supporting_documentation.file string (uri) Upload supporting documentation.
supporting_documentation.file_name string
supporting_documentation.file_size integer
supporting_documentation.created string (date-time)
onboarding_metadata object (free-form) Onboarding-specific data like intents, purposes extracted from checklist answers
user_submitted_customer_data object (free-form) Customer-related data submitted by the user via checklist answers
created string (date-time)
modified string (date-time)

Create justification for failed verification

Create justification for failed verification.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/onboarding-justifications/create_justification/ \
  Authorization:"Token YOUR_API_TOKEN" \
  verification_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.onboarding_justification_create_request import OnboardingJustificationCreateRequest # (1)
from waldur_api_client.api.onboarding_justifications import onboarding_justifications_create_justification # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OnboardingJustificationCreateRequest(
    verification_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
)
response = onboarding_justifications_create_justification.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OnboardingJustificationCreateRequest
  2. API Source: onboarding_justifications_create_justification
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { onboardingJustificationsCreateJustification } from 'waldur-js-client';

try {
  const response = await onboardingJustificationsCreateJustification({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "verification_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
verification_uuid string (uuid) ✓ UUID of the OnboardingVerification to justify
user_justification string User's explanation for why they should be authorized

200 -

Field Type Description
uuid string (uuid)
verification string (uri)
verification_uuid string (uuid)
country string
user string (uri)
user_full_name string
legal_person_identifier string
legal_name string
error_message string
error_traceback string
user_justification string User's explanation for why they should be authorized
validated_by string (uri)
validated_at string (date-time)
validation_decision any
staff_notes string Administrator notes on the review decision
supporting_documentation array of objects
supporting_documentation.uuid string (uuid)
supporting_documentation.file string (uri) Upload supporting documentation.
supporting_documentation.file_name string
supporting_documentation.file_size integer
supporting_documentation.created string (date-time)
onboarding_metadata object (free-form) Onboarding-specific data like intents, purposes extracted from checklist answers
user_submitted_customer_data object (free-form) Customer-related data submitted by the user via checklist answers
created string (date-time)
modified string (date-time)

Update

1
2
3
4
5
http \
  PUT \
  https://api.example.com/api/onboarding-justifications/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  verification="https://api.example.com/api/verification/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.onboarding_justification_request import OnboardingJustificationRequest # (1)
from waldur_api_client.api.onboarding_justifications import onboarding_justifications_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OnboardingJustificationRequest(
    verification="https://api.example.com/api/verification/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = onboarding_justifications_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OnboardingJustificationRequest
  2. API Source: onboarding_justifications_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { onboardingJustificationsUpdate } from 'waldur-js-client';

try {
  const response = await onboardingJustificationsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "verification": "https://api.example.com/api/verification/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
verification string (uri) ✓
user_justification string User's explanation for why they should be authorized

200 -

Field Type Description
uuid string (uuid)
verification string (uri)
verification_uuid string (uuid)
country string
user string (uri)
user_full_name string
legal_person_identifier string
legal_name string
error_message string
error_traceback string
user_justification string User's explanation for why they should be authorized
validated_by string (uri)
validated_at string (date-time)
validation_decision any
staff_notes string Administrator notes on the review decision
supporting_documentation array of objects
supporting_documentation.uuid string (uuid)
supporting_documentation.file string (uri) Upload supporting documentation.
supporting_documentation.file_name string
supporting_documentation.file_size integer
supporting_documentation.created string (date-time)
onboarding_metadata object (free-form) Onboarding-specific data like intents, purposes extracted from checklist answers
user_submitted_customer_data object (free-form) Customer-related data submitted by the user via checklist answers
created string (date-time)
modified string (date-time)

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/onboarding-justifications/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_onboarding_justification_request import PatchedOnboardingJustificationRequest # (1)
from waldur_api_client.api.onboarding_justifications import onboarding_justifications_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedOnboardingJustificationRequest()
response = onboarding_justifications_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedOnboardingJustificationRequest
  2. API Source: onboarding_justifications_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { onboardingJustificationsPartialUpdate } from 'waldur-js-client';

try {
  const response = await onboardingJustificationsPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
verification string (uri)
user_justification string User's explanation for why they should be authorized

200 -

Field Type Description
uuid string (uuid)
verification string (uri)
verification_uuid string (uuid)
country string
user string (uri)
user_full_name string
legal_person_identifier string
legal_name string
error_message string
error_traceback string
user_justification string User's explanation for why they should be authorized
validated_by string (uri)
validated_at string (date-time)
validation_decision any
staff_notes string Administrator notes on the review decision
supporting_documentation array of objects
supporting_documentation.uuid string (uuid)
supporting_documentation.file string (uri) Upload supporting documentation.
supporting_documentation.file_name string
supporting_documentation.file_size integer
supporting_documentation.created string (date-time)
onboarding_metadata object (free-form) Onboarding-specific data like intents, purposes extracted from checklist answers
user_submitted_customer_data object (free-form) Customer-related data submitted by the user via checklist answers
created string (date-time)
modified string (date-time)

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/onboarding-justifications/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.onboarding_justifications import onboarding_justifications_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = onboarding_justifications_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: onboarding_justifications_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { onboardingJustificationsDestroy } from 'waldur-js-client';

try {
  const response = await onboardingJustificationsDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Other Actions

Approve justification and mark verification as VERIFIED

Approve justification and mark verification as VERIFIED.

1
2
3
4
http \
  POST \
  https://api.example.com/api/onboarding-justifications/a1b2c3d4-e5f6-7890-abcd-ef1234567890/approve/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.onboarding_justification_review_request import OnboardingJustificationReviewRequest # (1)
from waldur_api_client.api.onboarding_justifications import onboarding_justifications_approve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OnboardingJustificationReviewRequest()
response = onboarding_justifications_approve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OnboardingJustificationReviewRequest
  2. API Source: onboarding_justifications_approve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { onboardingJustificationsApprove } from 'waldur-js-client';

try {
  const response = await onboardingJustificationsApprove({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
staff_notes string Administrator notes about the review decision

200 -

Field Type Description
uuid string (uuid)
verification string (uri)
verification_uuid string (uuid)
country string
user string (uri)
user_full_name string
legal_person_identifier string
legal_name string
error_message string
error_traceback string
user_justification string User's explanation for why they should be authorized
validated_by string (uri)
validated_at string (date-time)
validation_decision any
staff_notes string Administrator notes on the review decision
supporting_documentation array of objects
supporting_documentation.uuid string (uuid)
supporting_documentation.file string (uri) Upload supporting documentation.
supporting_documentation.file_name string
supporting_documentation.file_size integer
supporting_documentation.created string (date-time)
onboarding_metadata object (free-form) Onboarding-specific data like intents, purposes extracted from checklist answers
user_submitted_customer_data object (free-form) Customer-related data submitted by the user via checklist answers
created string (date-time)
modified string (date-time)

Attach supporting document to justification

Attach supporting document to justification.

1
2
3
4
http \
  POST \
  https://api.example.com/api/onboarding-justifications/a1b2c3d4-e5f6-7890-abcd-ef1234567890/attach_document/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.onboarding_justification_documentation_request import OnboardingJustificationDocumentationRequest # (1)
from waldur_api_client.api.onboarding_justifications import onboarding_justifications_attach_document # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OnboardingJustificationDocumentationRequest()
response = onboarding_justifications_attach_document.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OnboardingJustificationDocumentationRequest
  2. API Source: onboarding_justifications_attach_document
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { onboardingJustificationsAttachDocument } from 'waldur-js-client';

try {
  const response = await onboardingJustificationsAttachDocument({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
file string (binary) Upload supporting documentation.

200 -

Field Type Description
uuid string (uuid)
file string (uri) Upload supporting documentation.
file_name string
file_size integer
created string (date-time)

Reject justification and mark verification as FAILED

Reject justification and mark verification as FAILED.

1
2
3
4
http \
  POST \
  https://api.example.com/api/onboarding-justifications/a1b2c3d4-e5f6-7890-abcd-ef1234567890/reject/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.onboarding_justification_review_request import OnboardingJustificationReviewRequest # (1)
from waldur_api_client.api.onboarding_justifications import onboarding_justifications_reject # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OnboardingJustificationReviewRequest()
response = onboarding_justifications_reject.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OnboardingJustificationReviewRequest
  2. API Source: onboarding_justifications_reject
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { onboardingJustificationsReject } from 'waldur-js-client';

try {
  const response = await onboardingJustificationsReject({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
staff_notes string Administrator notes about the review decision

200 -

Field Type Description
uuid string (uuid)
verification string (uri)
verification_uuid string (uuid)
country string
user string (uri)
user_full_name string
legal_person_identifier string
legal_name string
error_message string
error_traceback string
user_justification string User's explanation for why they should be authorized
validated_by string (uri)
validated_at string (date-time)
validation_decision any
staff_notes string Administrator notes on the review decision
supporting_documentation array of objects
supporting_documentation.uuid string (uuid)
supporting_documentation.file string (uri) Upload supporting documentation.
supporting_documentation.file_name string
supporting_documentation.file_size integer
supporting_documentation.created string (date-time)
onboarding_metadata object (free-form) Onboarding-specific data like intents, purposes extracted from checklist answers
user_submitted_customer_data object (free-form) Customer-related data submitted by the user via checklist answers
created string (date-time)
modified string (date-time)

Onboarding Question Metadata

Operations Summary

Method Endpoint Description
GET /api/onboarding-question-metadata/ List Onboarding Question Metadata
GET /api/onboarding-question-metadata/{uuid}/ Retrieve
POST /api/onboarding-question-metadata/ Create
PUT /api/onboarding-question-metadata/{uuid}/ Update
PATCH /api/onboarding-question-metadata/{uuid}/ Partial Update
DELETE /api/onboarding-question-metadata/{uuid}/ Delete

List Onboarding Question Metadata

1
2
3
4
http \
  GET \
  https://api.example.com/api/onboarding-question-metadata/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.onboarding_question_metadata import onboarding_question_metadata_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = onboarding_question_metadata_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: onboarding_question_metadata_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { onboardingQuestionMetadataList } from 'waldur-js-client';

try {
  const response = await onboardingQuestionMetadataList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
checklist_uuid string (uuid) Checklist uuid
intent_field string
maps_to_customer_field string
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
question_description string
question_uuid string (uuid)

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid)
url string (uri)
checklist_name string
question string (uri)
question_uuid string (uuid)
question_description string
maps_to_customer_field string Customer model field name to map this answer to (e.g., 'registration_code', 'email', 'vat_code')
intent_field string Type of intent/purpose field (e.g., 'intent', 'registration_purpose') - stays with verification
created string (date-time)
modified string (date-time)

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/onboarding-question-metadata/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.onboarding_question_metadata import onboarding_question_metadata_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = onboarding_question_metadata_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: onboarding_question_metadata_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { onboardingQuestionMetadataRetrieve } from 'waldur-js-client';

try {
  const response = await onboardingQuestionMetadataRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
uuid string (uuid)
url string (uri)
checklist_name string
question string (uri)
question_uuid string (uuid)
question_description string
maps_to_customer_field string Customer model field name to map this answer to (e.g., 'registration_code', 'email', 'vat_code')
intent_field string Type of intent/purpose field (e.g., 'intent', 'registration_purpose') - stays with verification
created string (date-time)
modified string (date-time)

Create

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/onboarding-question-metadata/ \
  Authorization:"Token YOUR_API_TOKEN" \
  question="https://api.example.com/api/question/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.onboarding_question_metadata_request import OnboardingQuestionMetadataRequest # (1)
from waldur_api_client.api.onboarding_question_metadata import onboarding_question_metadata_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OnboardingQuestionMetadataRequest(
    question="https://api.example.com/api/question/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = onboarding_question_metadata_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OnboardingQuestionMetadataRequest
  2. API Source: onboarding_question_metadata_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { onboardingQuestionMetadataCreate } from 'waldur-js-client';

try {
  const response = await onboardingQuestionMetadataCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "question": "https://api.example.com/api/question/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
question string (uri) ✓
maps_to_customer_field string Customer model field name to map this answer to (e.g., 'registration_code', 'email', 'vat_code')
intent_field string Type of intent/purpose field (e.g., 'intent', 'registration_purpose') - stays with verification

201 -

Field Type Description
uuid string (uuid)
url string (uri)
checklist_name string
question string (uri)
question_uuid string (uuid)
question_description string
maps_to_customer_field string Customer model field name to map this answer to (e.g., 'registration_code', 'email', 'vat_code')
intent_field string Type of intent/purpose field (e.g., 'intent', 'registration_purpose') - stays with verification
created string (date-time)
modified string (date-time)

Update

1
2
3
4
5
http \
  PUT \
  https://api.example.com/api/onboarding-question-metadata/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  question="https://api.example.com/api/question/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.onboarding_question_metadata_request import OnboardingQuestionMetadataRequest # (1)
from waldur_api_client.api.onboarding_question_metadata import onboarding_question_metadata_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OnboardingQuestionMetadataRequest(
    question="https://api.example.com/api/question/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = onboarding_question_metadata_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OnboardingQuestionMetadataRequest
  2. API Source: onboarding_question_metadata_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { onboardingQuestionMetadataUpdate } from 'waldur-js-client';

try {
  const response = await onboardingQuestionMetadataUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "question": "https://api.example.com/api/question/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
question string (uri) ✓
maps_to_customer_field string Customer model field name to map this answer to (e.g., 'registration_code', 'email', 'vat_code')
intent_field string Type of intent/purpose field (e.g., 'intent', 'registration_purpose') - stays with verification

200 -

Field Type Description
uuid string (uuid)
url string (uri)
checklist_name string
question string (uri)
question_uuid string (uuid)
question_description string
maps_to_customer_field string Customer model field name to map this answer to (e.g., 'registration_code', 'email', 'vat_code')
intent_field string Type of intent/purpose field (e.g., 'intent', 'registration_purpose') - stays with verification
created string (date-time)
modified string (date-time)

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/onboarding-question-metadata/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_onboarding_question_metadata_request import PatchedOnboardingQuestionMetadataRequest # (1)
from waldur_api_client.api.onboarding_question_metadata import onboarding_question_metadata_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedOnboardingQuestionMetadataRequest()
response = onboarding_question_metadata_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedOnboardingQuestionMetadataRequest
  2. API Source: onboarding_question_metadata_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { onboardingQuestionMetadataPartialUpdate } from 'waldur-js-client';

try {
  const response = await onboardingQuestionMetadataPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
question string (uri)
maps_to_customer_field string Customer model field name to map this answer to (e.g., 'registration_code', 'email', 'vat_code')
intent_field string Type of intent/purpose field (e.g., 'intent', 'registration_purpose') - stays with verification

200 -

Field Type Description
uuid string (uuid)
url string (uri)
checklist_name string
question string (uri)
question_uuid string (uuid)
question_description string
maps_to_customer_field string Customer model field name to map this answer to (e.g., 'registration_code', 'email', 'vat_code')
intent_field string Type of intent/purpose field (e.g., 'intent', 'registration_purpose') - stays with verification
created string (date-time)
modified string (date-time)

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/onboarding-question-metadata/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.onboarding_question_metadata import onboarding_question_metadata_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = onboarding_question_metadata_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: onboarding_question_metadata_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { onboardingQuestionMetadataDestroy } from 'waldur-js-client';

try {
  const response = await onboardingQuestionMetadataDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Onboarding Verifications

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/onboarding-verifications/ List Onboarding Verifications
GET /api/onboarding-verifications/{uuid}/ Retrieve
POST /api/onboarding-verifications/ Create
POST /api/onboarding-verifications/{uuid}/create_customer/ Create customer from successful verification
PUT /api/onboarding-verifications/{uuid}/ Update
PATCH /api/onboarding-verifications/{uuid}/ Partial Update
DELETE /api/onboarding-verifications/{uuid}/ Delete
Other Actions
GET /api/onboarding-verifications/available_checklists/ Available checklists
GET /api/onboarding-verifications/{uuid}/checklist/ Checklist
GET /api/onboarding-verifications/checklist-template/ Get checklist template for creating new objects
GET /api/onboarding-verifications/{uuid}/completion_status/ Completion status
POST /api/onboarding-verifications/{uuid}/run_validation/ Run validation
POST /api/onboarding-verifications/start_verification/ Start verification
POST /api/onboarding-verifications/{uuid}/submit_answers/ Submit answers

Core CRUD

List Onboarding Verifications

1
2
3
4
http \
  GET \
  https://api.example.com/api/onboarding-verifications/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.onboarding_verification_o_enum import OnboardingVerificationOEnum # (1)
from waldur_api_client.models.onboarding_verification_status_enum1 import OnboardingVerificationStatusEnum1 # (2)
from waldur_api_client.models.onboarding_verification_validation_method_enum import OnboardingVerificationValidationMethodEnum # (3)
from waldur_api_client.api.onboarding_verifications import onboarding_verifications_list # (4)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = onboarding_verifications_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: OnboardingVerificationOEnum
  2. Model Source: OnboardingVerificationStatusEnum1
  3. Model Source: OnboardingVerificationValidationMethodEnum
  4. API Source: onboarding_verifications_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { onboardingVerificationsList } from 'waldur-js-client';

try {
  const response = await onboardingVerificationsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
country string
legal_name string
legal_person_identifier string
o array Ordering
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
query string Filter by legal name, legal person identifier
status array Verification status
user_uuid string (uuid) User UUID
validation_method array Validation method

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid)
user string (uri) User requesting company onboarding
user_full_name string
country string ISO country code (e.g., 'EE', 'AT') for context. Can be inferred from validation_method.
legal_person_identifier string Official company registration code (required for automatic validation)
legal_name string Company name(optional, for reference)
status any
justifications array of objects
justifications.uuid string (uuid)
justifications.verification string (uri)
justifications.verification_uuid string (uuid)
justifications.country string
justifications.user string (uri)
justifications.user_full_name string
justifications.legal_person_identifier string
justifications.legal_name string
justifications.error_message string
justifications.error_traceback string
justifications.user_justification string User's explanation for why they should be authorized
justifications.validated_by string (uri)
justifications.validated_at string (date-time)
justifications.validation_decision any
justifications.staff_notes string Administrator notes on the review decision
justifications.supporting_documentation array of objects
justifications.supporting_documentation.uuid string (uuid)
justifications.supporting_documentation.file string (uri) Upload supporting documentation.
justifications.supporting_documentation.file_name string
justifications.supporting_documentation.file_size integer
justifications.supporting_documentation.created string (date-time)
justifications.onboarding_metadata object (free-form) Onboarding-specific data like intents, purposes extracted from checklist answers
justifications.user_submitted_customer_data object (free-form) Customer-related data submitted by the user via checklist answers
justifications.created string (date-time)
justifications.modified string (date-time)
validation_method any Method used for validation
verified_user_roles any Roles the user has in the company
verified_company_data any Company information retrieved during validation
raw_response any Raw API response for debugging and auditing
error_traceback string
error_message string
validated_at string (date-time) When validation was completed
expires_at string (date-time) When this verification expires
customer string (uri) Customer created after successful validation
onboarding_metadata object (free-form) Onboarding-specific data like intents, purposes extracted from checklist answers
user_submitted_customer_data object (free-form) Get customer data submitted by the user during onboarding.
can_customer_be_created boolean Boolean indicating if a customer can be created from this verification
customer_creation_error_message string Reason why customer cannot be created (null if can be created)
created string (date-time)
modified string (date-time)

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/onboarding-verifications/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.onboarding_verifications import onboarding_verifications_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = onboarding_verifications_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: onboarding_verifications_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { onboardingVerificationsRetrieve } from 'waldur-js-client';

try {
  const response = await onboardingVerificationsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
uuid string (uuid)
user string (uri) User requesting company onboarding
user_full_name string
country string ISO country code (e.g., 'EE', 'AT') for context. Can be inferred from validation_method.
legal_person_identifier string Official company registration code (required for automatic validation)
legal_name string Company name(optional, for reference)
status any
justifications array of objects
justifications.uuid string (uuid)
justifications.verification string (uri)
justifications.verification_uuid string (uuid)
justifications.country string
justifications.user string (uri)
justifications.user_full_name string
justifications.legal_person_identifier string
justifications.legal_name string
justifications.error_message string
justifications.error_traceback string
justifications.user_justification string User's explanation for why they should be authorized
justifications.validated_by string (uri)
justifications.validated_at string (date-time)
justifications.validation_decision any
justifications.staff_notes string Administrator notes on the review decision
justifications.supporting_documentation array of objects
justifications.supporting_documentation.uuid string (uuid)
justifications.supporting_documentation.file string (uri) Upload supporting documentation.
justifications.supporting_documentation.file_name string
justifications.supporting_documentation.file_size integer
justifications.supporting_documentation.created string (date-time)
justifications.onboarding_metadata object (free-form) Onboarding-specific data like intents, purposes extracted from checklist answers
justifications.user_submitted_customer_data object (free-form) Customer-related data submitted by the user via checklist answers
justifications.created string (date-time)
justifications.modified string (date-time)
validation_method any Method used for validation
verified_user_roles any Roles the user has in the company
verified_company_data any Company information retrieved during validation
raw_response any Raw API response for debugging and auditing
error_traceback string
error_message string
validated_at string (date-time) When validation was completed
expires_at string (date-time) When this verification expires
customer string (uri) Customer created after successful validation
onboarding_metadata object (free-form) Onboarding-specific data like intents, purposes extracted from checklist answers
user_submitted_customer_data object (free-form) Get customer data submitted by the user during onboarding.
can_customer_be_created boolean Boolean indicating if a customer can be created from this verification
customer_creation_error_message string Reason why customer cannot be created (null if can be created)
created string (date-time)
modified string (date-time)

Create

1
2
3
4
http \
  POST \
  https://api.example.com/api/onboarding-verifications/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.onboarding_verification_request import OnboardingVerificationRequest # (1)
from waldur_api_client.api.onboarding_verifications import onboarding_verifications_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OnboardingVerificationRequest()
response = onboarding_verifications_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OnboardingVerificationRequest
  2. API Source: onboarding_verifications_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { onboardingVerificationsCreate } from 'waldur-js-client';

try {
  const response = await onboardingVerificationsCreate({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
country string ISO country code (e.g., 'EE', 'AT') for context. Can be inferred from validation_method.
legal_person_identifier string Official company registration code (required for automatic validation)
legal_name string Company name(optional, for reference)
expires_at string (date-time) When this verification expires

201 -

Field Type Description
uuid string (uuid)
user string (uri) User requesting company onboarding
user_full_name string
country string ISO country code (e.g., 'EE', 'AT') for context. Can be inferred from validation_method.
legal_person_identifier string Official company registration code (required for automatic validation)
legal_name string Company name(optional, for reference)
status any
justifications array of objects
justifications.uuid string (uuid)
justifications.verification string (uri)
justifications.verification_uuid string (uuid)
justifications.country string
justifications.user string (uri)
justifications.user_full_name string
justifications.legal_person_identifier string
justifications.legal_name string
justifications.error_message string
justifications.error_traceback string
justifications.user_justification string User's explanation for why they should be authorized
justifications.validated_by string (uri)
justifications.validated_at string (date-time)
justifications.validation_decision any
justifications.staff_notes string Administrator notes on the review decision
justifications.supporting_documentation array of objects
justifications.supporting_documentation.uuid string (uuid)
justifications.supporting_documentation.file string (uri) Upload supporting documentation.
justifications.supporting_documentation.file_name string
justifications.supporting_documentation.file_size integer
justifications.supporting_documentation.created string (date-time)
justifications.onboarding_metadata object (free-form) Onboarding-specific data like intents, purposes extracted from checklist answers
justifications.user_submitted_customer_data object (free-form) Customer-related data submitted by the user via checklist answers
justifications.created string (date-time)
justifications.modified string (date-time)
validation_method any Method used for validation
verified_user_roles any Roles the user has in the company
verified_company_data any Company information retrieved during validation
raw_response any Raw API response for debugging and auditing
error_traceback string
error_message string
validated_at string (date-time) When validation was completed
expires_at string (date-time) When this verification expires
customer string (uri) Customer created after successful validation
onboarding_metadata object (free-form) Onboarding-specific data like intents, purposes extracted from checklist answers
user_submitted_customer_data object (free-form) Get customer data submitted by the user during onboarding.
can_customer_be_created boolean Boolean indicating if a customer can be created from this verification
customer_creation_error_message string Reason why customer cannot be created (null if can be created)
created string (date-time)
modified string (date-time)

Create customer from successful verification

Create customer from successful verification.

1
2
3
4
http \
  POST \
  https://api.example.com/api/onboarding-verifications/a1b2c3d4-e5f6-7890-abcd-ef1234567890/create_customer/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.onboarding_verifications import onboarding_verifications_create_customer # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = onboarding_verifications_create_customer.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: onboarding_verifications_create_customer
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { onboardingVerificationsCreateCustomer } from 'waldur-js-client';

try {
  const response = await onboardingVerificationsCreateCustomer({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

201 -

Field Type Description
url string (uri)
uuid string (uuid)
created string (date-time)
organization_groups array of objects Organization groups this customer belongs to
organization_groups.uuid string (uuid)
organization_groups.url string (uri)
organization_groups.name string
organization_groups.parent_uuid string (uuid) UUID of the parent organization group
organization_groups.parent_name string Name of the parent organization group
organization_groups.parent string (uri)
organization_groups.customers_count integer Number of customers in this organization group
display_name string Display name of the organization (includes native name if available)
backend_id string Organization identifier in another application.
image string (uri)
blocked boolean
archived boolean
display_billing_info_in_projects boolean
default_tax_percent string (decimal)
accounting_start_date string (date-time)
projects_count integer Number of projects in this organization
users_count integer Number of users with access to this organization
sponsor_number integer External ID of the sponsor covering the costs
country_name string Human-readable country name
max_service_accounts integer Maximum number of service accounts allowed
project_metadata_checklist string (uuid) Checklist to be used for project metadata validation in this organization
grace_period_days integer Number of extra days after project end date before resources are terminated
user_email_patterns any
user_affiliations any
user_identity_sources any List of allowed identity sources (identity providers).
name string
slug string URL-friendly identifier. Only editable by staff users.
native_name string
abbreviation string
description string
contact_details string
agreement_number string
email string (email)
phone_number string
access_subnets string Enter a comma separated list of IPv4 or IPv6 CIDR addresses from where connection to self-service is allowed.
registration_code string
homepage string (uri)
domain string
vat_code string VAT number
postal string
address string
bank_name string
latitude number (double)
longitude number (double)
bank_account string
country any Country code (ISO 3166-1 alpha-2)
notification_emails string Comma-separated list of notification email addresses
payment_profiles array of objects
payment_profiles.uuid string (uuid)
payment_profiles.url string (uri)
payment_profiles.name string
payment_profiles.organization_uuid string (uuid)
payment_profiles.organization string (uri)
payment_profiles.attributes object
payment_profiles.attributes.end_date string
payment_profiles.attributes.agreement_number string
payment_profiles.attributes.contract_sum integer
payment_profiles.payment_type string
Enum: fixed_price, invoices, payment_gw_monthly
payment_profiles.payment_type_display string
payment_profiles.is_active boolean
customer_credit number (double)
customer_unallocated_credit number (double)
is_service_provider boolean
service_provider string (uri)
service_provider_uuid string (uuid)
call_managing_organization_uuid string
billing_price_estimate any

Update

1
2
3
4
http \
  PUT \
  https://api.example.com/api/onboarding-verifications/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.onboarding_verification_request import OnboardingVerificationRequest # (1)
from waldur_api_client.api.onboarding_verifications import onboarding_verifications_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OnboardingVerificationRequest()
response = onboarding_verifications_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OnboardingVerificationRequest
  2. API Source: onboarding_verifications_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { onboardingVerificationsUpdate } from 'waldur-js-client';

try {
  const response = await onboardingVerificationsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
country string ISO country code (e.g., 'EE', 'AT') for context. Can be inferred from validation_method.
legal_person_identifier string Official company registration code (required for automatic validation)
legal_name string Company name(optional, for reference)
expires_at string (date-time) When this verification expires

200 -

Field Type Description
uuid string (uuid)
user string (uri) User requesting company onboarding
user_full_name string
country string ISO country code (e.g., 'EE', 'AT') for context. Can be inferred from validation_method.
legal_person_identifier string Official company registration code (required for automatic validation)
legal_name string Company name(optional, for reference)
status any
justifications array of objects
justifications.uuid string (uuid)
justifications.verification string (uri)
justifications.verification_uuid string (uuid)
justifications.country string
justifications.user string (uri)
justifications.user_full_name string
justifications.legal_person_identifier string
justifications.legal_name string
justifications.error_message string
justifications.error_traceback string
justifications.user_justification string User's explanation for why they should be authorized
justifications.validated_by string (uri)
justifications.validated_at string (date-time)
justifications.validation_decision any
justifications.staff_notes string Administrator notes on the review decision
justifications.supporting_documentation array of objects
justifications.supporting_documentation.uuid string (uuid)
justifications.supporting_documentation.file string (uri) Upload supporting documentation.
justifications.supporting_documentation.file_name string
justifications.supporting_documentation.file_size integer
justifications.supporting_documentation.created string (date-time)
justifications.onboarding_metadata object (free-form) Onboarding-specific data like intents, purposes extracted from checklist answers
justifications.user_submitted_customer_data object (free-form) Customer-related data submitted by the user via checklist answers
justifications.created string (date-time)
justifications.modified string (date-time)
validation_method any Method used for validation
verified_user_roles any Roles the user has in the company
verified_company_data any Company information retrieved during validation
raw_response any Raw API response for debugging and auditing
error_traceback string
error_message string
validated_at string (date-time) When validation was completed
expires_at string (date-time) When this verification expires
customer string (uri) Customer created after successful validation
onboarding_metadata object (free-form) Onboarding-specific data like intents, purposes extracted from checklist answers
user_submitted_customer_data object (free-form) Get customer data submitted by the user during onboarding.
can_customer_be_created boolean Boolean indicating if a customer can be created from this verification
customer_creation_error_message string Reason why customer cannot be created (null if can be created)
created string (date-time)
modified string (date-time)

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/onboarding-verifications/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_onboarding_verification_request import PatchedOnboardingVerificationRequest # (1)
from waldur_api_client.api.onboarding_verifications import onboarding_verifications_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedOnboardingVerificationRequest()
response = onboarding_verifications_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedOnboardingVerificationRequest
  2. API Source: onboarding_verifications_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { onboardingVerificationsPartialUpdate } from 'waldur-js-client';

try {
  const response = await onboardingVerificationsPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
country string ISO country code (e.g., 'EE', 'AT') for context. Can be inferred from validation_method.
legal_person_identifier string Official company registration code (required for automatic validation)
legal_name string Company name(optional, for reference)
expires_at string (date-time) When this verification expires

200 -

Field Type Description
uuid string (uuid)
user string (uri) User requesting company onboarding
user_full_name string
country string ISO country code (e.g., 'EE', 'AT') for context. Can be inferred from validation_method.
legal_person_identifier string Official company registration code (required for automatic validation)
legal_name string Company name(optional, for reference)
status any
justifications array of objects
justifications.uuid string (uuid)
justifications.verification string (uri)
justifications.verification_uuid string (uuid)
justifications.country string
justifications.user string (uri)
justifications.user_full_name string
justifications.legal_person_identifier string
justifications.legal_name string
justifications.error_message string
justifications.error_traceback string
justifications.user_justification string User's explanation for why they should be authorized
justifications.validated_by string (uri)
justifications.validated_at string (date-time)
justifications.validation_decision any
justifications.staff_notes string Administrator notes on the review decision
justifications.supporting_documentation array of objects
justifications.supporting_documentation.uuid string (uuid)
justifications.supporting_documentation.file string (uri) Upload supporting documentation.
justifications.supporting_documentation.file_name string
justifications.supporting_documentation.file_size integer
justifications.supporting_documentation.created string (date-time)
justifications.onboarding_metadata object (free-form) Onboarding-specific data like intents, purposes extracted from checklist answers
justifications.user_submitted_customer_data object (free-form) Customer-related data submitted by the user via checklist answers
justifications.created string (date-time)
justifications.modified string (date-time)
validation_method any Method used for validation
verified_user_roles any Roles the user has in the company
verified_company_data any Company information retrieved during validation
raw_response any Raw API response for debugging and auditing
error_traceback string
error_message string
validated_at string (date-time) When validation was completed
expires_at string (date-time) When this verification expires
customer string (uri) Customer created after successful validation
onboarding_metadata object (free-form) Onboarding-specific data like intents, purposes extracted from checklist answers
user_submitted_customer_data object (free-form) Get customer data submitted by the user during onboarding.
can_customer_be_created boolean Boolean indicating if a customer can be created from this verification
customer_creation_error_message string Reason why customer cannot be created (null if can be created)
created string (date-time)
modified string (date-time)

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/onboarding-verifications/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.onboarding_verifications import onboarding_verifications_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = onboarding_verifications_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: onboarding_verifications_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { onboardingVerificationsDestroy } from 'waldur-js-client';

try {
  const response = await onboardingVerificationsDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Other Actions

Available checklists

Get available onboarding checklists (customer and intent) for preview. This endpoint allows users to see checklist questions before creating a verification. Supports checklist_type parameter to filter by customer or intent checklists. Includes questions with onboarding metadata (field mappings).

1
2
3
4
http \
  GET \
  https://api.example.com/api/onboarding-verifications/available_checklists/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.available_checklists_response_checklist_type_enum import AvailableChecklistsResponseChecklistTypeEnum # (1)
from waldur_api_client.api.onboarding_verifications import onboarding_verifications_available_checklists_retrieve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = onboarding_verifications_available_checklists_retrieve.sync(client=client)

print(response)
  1. Model Source: AvailableChecklistsResponseChecklistTypeEnum
  2. API Source: onboarding_verifications_available_checklists_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { onboardingVerificationsAvailableChecklistsRetrieve } from 'waldur-js-client';

try {
  const response = await onboardingVerificationsAvailableChecklistsRetrieve({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
checklist_type string Type of checklist to retrieve (customer, intent, or all). Defaults to all.
Enum: customer, intent, all

200 -

Field Type
customer_checklist object (free-form)
intent_checklist object (free-form)

Checklist

Get checklist with questions and existing answers. Supports both customer and intent checklists via checklist_type parameter.

1
2
3
4
http \
  GET \
  https://api.example.com/api/onboarding-verifications/a1b2c3d4-e5f6-7890-abcd-ef1234567890/checklist/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.checklist_response_checklist_type_enum import ChecklistResponseChecklistTypeEnum # (1)
from waldur_api_client.api.onboarding_verifications import onboarding_verifications_checklist_retrieve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = onboarding_verifications_checklist_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. Model Source: ChecklistResponseChecklistTypeEnum
  2. API Source: onboarding_verifications_checklist_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { onboardingVerificationsChecklistRetrieve } from 'waldur-js-client';

try {
  const response = await onboardingVerificationsChecklistRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type Description
checklist_type string Type of checklist to retrieve (customer or intent). Defaults to intent.
Enum: customer, intent
include_all boolean If true, returns all questions including hidden ones.
Default: False

200 -

Field Type Description
checklist object (free-form)
completion object
completion.uuid string (uuid)
completion.is_completed boolean Whether all required questions have been answered
completion.completion_percentage number (double)
completion.unanswered_required_questions array of anys
completion.checklist_name string
completion.checklist_description string
completion.created string (date-time)
completion.modified string (date-time)
questions array of objects
questions.uuid string (uuid)
questions.description string
questions.user_guidance string
questions.question_type any Type of question and expected answer format
questions.required boolean
questions.order integer
questions.existing_answer object (free-form)
questions.question_options array of anys
questions.min_value string (decimal) Minimum value allowed for NUMBER, YEAR, and RATING type questions
questions.max_value string (decimal) Maximum value allowed for NUMBER, YEAR, and RATING type questions
questions.allowed_file_types any List of allowed file extensions (e.g., ['.pdf', '.doc', '.docx']). If empty, all file types are allowed.
questions.allowed_mime_types any List of allowed MIME types (e.g., ['application/pdf', 'application/msword']). If empty, MIME type validation is not enforced. When both extensions and MIME types are specified, files must match both criteria for security.
questions.max_file_size_mb integer Maximum file size in megabytes. If not set, no size limit is enforced.
questions.max_files_count integer Maximum number of files allowed for MULTIPLE_FILES type questions. If not set, no count limit is enforced.
questions.dependencies_info object (free-form)

Get checklist template for creating new objects

Get checklist template for creating new objects.

1
2
3
4
5
http \
  GET \
  https://api.example.com/api/onboarding-verifications/checklist-template/ \
  Authorization:"Token YOUR_API_TOKEN" \
  parent_uuid=="a1b2c3d4-e5f6-7890-abcd-ef1234567890"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.onboarding_verifications import onboarding_verifications_checklist_template_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = onboarding_verifications_checklist_template_retrieve.sync(
    client=client,
    parent_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
)

print(response)
  1. API Source: onboarding_verifications_checklist_template_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { onboardingVerificationsChecklistTemplateRetrieve } from 'waldur-js-client';

try {
  const response = await onboardingVerificationsChecklistTemplateRetrieve({
  auth: "Token YOUR_API_TOKEN",
  query: {
    "parent_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
parent_uuid string (uuid) ✓ UUID of the parent object (e.g., customer UUID for new projects)

200 -

Field Type Description
checklist object (free-form)
questions array of objects
questions.uuid string (uuid)
questions.required boolean
questions.description string
questions.user_guidance string Additional guidance text visible to users when answering and reviewing
questions.question_options array of objects
questions.question_options.uuid string (uuid)
questions.question_options.label string
questions.question_options.order integer
questions.question_type any Type of question and expected answer format
questions.order integer
questions.min_value string (decimal) Minimum value allowed for NUMBER, YEAR, and RATING type questions
questions.max_value string (decimal) Maximum value allowed for NUMBER, YEAR, and RATING type questions
questions.allowed_file_types any List of allowed file extensions (e.g., ['.pdf', '.doc', '.docx']). If empty, all file types are allowed.
questions.allowed_mime_types any List of allowed MIME types (e.g., ['application/pdf', 'application/msword']). If empty, MIME type validation is not enforced. When both extensions and MIME types are specified, files must match both criteria for security.
questions.max_file_size_mb integer Maximum file size in megabytes. If not set, no size limit is enforced.
questions.max_files_count integer Maximum number of files allowed for MULTIPLE_FILES type questions. If not set, no count limit is enforced.
questions.operator any
questions.review_answer_value any Answer value that trigger review.
questions.always_requires_review boolean This question always requires review regardless of answer
questions.guidance_answer_value any Answer value that triggers display of user guidance.
questions.guidance_operator any Operator to use when comparing answer with guidance_answer_value
questions.always_show_guidance boolean Show user guidance always, regardless of answer. If False, guidance is conditional on answer matching guidance_answer_value with guidance_operator
questions.dependency_logic_operator any Defines how multiple dependencies are evaluated. AND: All dependencies must be satisfied. OR: At least one dependency must be satisfied.
initial_visible_questions array of objects
initial_visible_questions.uuid string (uuid)
initial_visible_questions.required boolean
initial_visible_questions.description string
initial_visible_questions.user_guidance string Additional guidance text visible to users when answering and reviewing
initial_visible_questions.question_options array of objects
initial_visible_questions.question_options.uuid string (uuid)
initial_visible_questions.question_options.label string
initial_visible_questions.question_options.order integer
initial_visible_questions.question_type any Type of question and expected answer format
initial_visible_questions.order integer
initial_visible_questions.min_value string (decimal) Minimum value allowed for NUMBER, YEAR, and RATING type questions
initial_visible_questions.max_value string (decimal) Maximum value allowed for NUMBER, YEAR, and RATING type questions
initial_visible_questions.allowed_file_types any List of allowed file extensions (e.g., ['.pdf', '.doc', '.docx']). If empty, all file types are allowed.
initial_visible_questions.allowed_mime_types any List of allowed MIME types (e.g., ['application/pdf', 'application/msword']). If empty, MIME type validation is not enforced. When both extensions and MIME types are specified, files must match both criteria for security.
initial_visible_questions.max_file_size_mb integer Maximum file size in megabytes. If not set, no size limit is enforced.
initial_visible_questions.max_files_count integer Maximum number of files allowed for MULTIPLE_FILES type questions. If not set, no count limit is enforced.
initial_visible_questions.operator any
initial_visible_questions.review_answer_value any Answer value that trigger review.
initial_visible_questions.always_requires_review boolean This question always requires review regardless of answer
initial_visible_questions.guidance_answer_value any Answer value that triggers display of user guidance.
initial_visible_questions.guidance_operator any Operator to use when comparing answer with guidance_answer_value
initial_visible_questions.always_show_guidance boolean Show user guidance always, regardless of answer. If False, guidance is conditional on answer matching guidance_answer_value with guidance_operator
initial_visible_questions.dependency_logic_operator any Defines how multiple dependencies are evaluated. AND: All dependencies must be satisfied. OR: At least one dependency must be satisfied.

400 -

404 -

Completion status

Get checklist completion status. Supports both customer and intent checklists via checklist_type parameter.

1
2
3
4
http \
  GET \
  https://api.example.com/api/onboarding-verifications/a1b2c3d4-e5f6-7890-abcd-ef1234567890/completion_status/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.checklist_response_checklist_type_enum import ChecklistResponseChecklistTypeEnum # (1)
from waldur_api_client.api.onboarding_verifications import onboarding_verifications_completion_status_retrieve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = onboarding_verifications_completion_status_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. Model Source: ChecklistResponseChecklistTypeEnum
  2. API Source: onboarding_verifications_completion_status_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { onboardingVerificationsCompletionStatusRetrieve } from 'waldur-js-client';

try {
  const response = await onboardingVerificationsCompletionStatusRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type Description
checklist_type string Type of checklist to retrieve (customer or intent). Defaults to intent.
Enum: customer, intent

200 -

Field Type Description
uuid string (uuid)
is_completed boolean Whether all required questions have been answered
completion_percentage number (double)
unanswered_required_questions array of anys
checklist_name string
checklist_description string
created string (date-time)
modified string (date-time)

Run validation

Run automatic validation using the required fields provided during verification creation. Checklist answers (if any) are only used for supplemental customer/intent data.

1
2
3
4
http \
  POST \
  https://api.example.com/api/onboarding-verifications/a1b2c3d4-e5f6-7890-abcd-ef1234567890/run_validation/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.onboarding_run_validation_request_request import OnboardingRunValidationRequestRequest # (1)
from waldur_api_client.api.onboarding_verifications import onboarding_verifications_run_validation # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OnboardingRunValidationRequestRequest()
response = onboarding_verifications_run_validation.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OnboardingRunValidationRequestRequest
  2. API Source: onboarding_verifications_run_validation
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { onboardingVerificationsRunValidation } from 'waldur-js-client';

try {
  const response = await onboardingVerificationsRunValidation({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
civil_number string Personal identifier (temporary workaround for Estonian civil_number)
first_name string User's first name (temporary workaround for Austrian validation)
last_name string User's last name (temporary workaround for Austrian validation)
birth_date string (date) User's birth date (temporary workaround for Austrian validation)

200 -

Field Type Description
uuid string (uuid)
user string (uri) User requesting company onboarding
user_full_name string
country string ISO country code (e.g., 'EE', 'AT') for context. Can be inferred from validation_method.
legal_person_identifier string Official company registration code (required for automatic validation)
legal_name string Company name(optional, for reference)
status any
justifications array of objects
justifications.uuid string (uuid)
justifications.verification string (uri)
justifications.verification_uuid string (uuid)
justifications.country string
justifications.user string (uri)
justifications.user_full_name string
justifications.legal_person_identifier string
justifications.legal_name string
justifications.error_message string
justifications.error_traceback string
justifications.user_justification string User's explanation for why they should be authorized
justifications.validated_by string (uri)
justifications.validated_at string (date-time)
justifications.validation_decision any
justifications.staff_notes string Administrator notes on the review decision
justifications.supporting_documentation array of objects
justifications.supporting_documentation.uuid string (uuid)
justifications.supporting_documentation.file string (uri) Upload supporting documentation.
justifications.supporting_documentation.file_name string
justifications.supporting_documentation.file_size integer
justifications.supporting_documentation.created string (date-time)
justifications.onboarding_metadata object (free-form) Onboarding-specific data like intents, purposes extracted from checklist answers
justifications.user_submitted_customer_data object (free-form) Customer-related data submitted by the user via checklist answers
justifications.created string (date-time)
justifications.modified string (date-time)
validation_method any Method used for validation
verified_user_roles any Roles the user has in the company
verified_company_data any Company information retrieved during validation
raw_response any Raw API response for debugging and auditing
error_traceback string
error_message string
validated_at string (date-time) When validation was completed
expires_at string (date-time) When this verification expires
customer string (uri) Customer created after successful validation
onboarding_metadata object (free-form) Onboarding-specific data like intents, purposes extracted from checklist answers
user_submitted_customer_data object (free-form) Get customer data submitted by the user during onboarding.
can_customer_be_created boolean Boolean indicating if a customer can be created from this verification
customer_creation_error_message string Reason why customer cannot be created (null if can be created)
created string (date-time)
modified string (date-time)

Start verification

Start company validation process by creating a verification record. User selects validation_method (e.g., 'ariregister', 'wirtschaftscompass'). Checklists are used for intent and customer data collection. Then call run_validation to perform automatic validation or create manual justification.

1
2
3
4
http \
  POST \
  https://api.example.com/api/onboarding-verifications/start_verification/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.onboarding_company_validation_request_request import OnboardingCompanyValidationRequestRequest # (1)
from waldur_api_client.api.onboarding_verifications import onboarding_verifications_start_verification # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OnboardingCompanyValidationRequestRequest()
response = onboarding_verifications_start_verification.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OnboardingCompanyValidationRequestRequest
  2. API Source: onboarding_verifications_start_verification
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { onboardingVerificationsStartVerification } from 'waldur-js-client';

try {
  const response = await onboardingVerificationsStartVerification({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
validation_method any Automatic validation method (e.g., 'ariregister', 'wirtschaftscompass', 'bolagsverket'). Leave empty for manual validation.
country string ISO country code (e.g., 'EE', 'AT') - optional, for display context
legal_person_identifier string Official company registration code
legal_name string Company name (optional)

200 -

Field Type Description
uuid string (uuid)
user string (uri) User requesting company onboarding
user_full_name string
country string ISO country code (e.g., 'EE', 'AT') for context. Can be inferred from validation_method.
legal_person_identifier string Official company registration code (required for automatic validation)
legal_name string Company name(optional, for reference)
status any
justifications array of objects
justifications.uuid string (uuid)
justifications.verification string (uri)
justifications.verification_uuid string (uuid)
justifications.country string
justifications.user string (uri)
justifications.user_full_name string
justifications.legal_person_identifier string
justifications.legal_name string
justifications.error_message string
justifications.error_traceback string
justifications.user_justification string User's explanation for why they should be authorized
justifications.validated_by string (uri)
justifications.validated_at string (date-time)
justifications.validation_decision any
justifications.staff_notes string Administrator notes on the review decision
justifications.supporting_documentation array of objects
justifications.supporting_documentation.uuid string (uuid)
justifications.supporting_documentation.file string (uri) Upload supporting documentation.
justifications.supporting_documentation.file_name string
justifications.supporting_documentation.file_size integer
justifications.supporting_documentation.created string (date-time)
justifications.onboarding_metadata object (free-form) Onboarding-specific data like intents, purposes extracted from checklist answers
justifications.user_submitted_customer_data object (free-form) Customer-related data submitted by the user via checklist answers
justifications.created string (date-time)
justifications.modified string (date-time)
validation_method any Method used for validation
verified_user_roles any Roles the user has in the company
verified_company_data any Company information retrieved during validation
raw_response any Raw API response for debugging and auditing
error_traceback string
error_message string
validated_at string (date-time) When validation was completed
expires_at string (date-time) When this verification expires
customer string (uri) Customer created after successful validation
onboarding_metadata object (free-form) Onboarding-specific data like intents, purposes extracted from checklist answers
user_submitted_customer_data object (free-form) Get customer data submitted by the user during onboarding.
can_customer_be_created boolean Boolean indicating if a customer can be created from this verification
customer_creation_error_message string Reason why customer cannot be created (null if can be created)
created string (date-time)
modified string (date-time)

Submit answers

Submit answers to checklist questions. Automatically detects which checklist (customer or intent) each question belongs to.

1
2
3
4
echo '[{"question_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "answer_data": null}]' | http \
  POST \
  https://api.example.com/api/onboarding-verifications/a1b2c3d4-e5f6-7890-abcd-ef1234567890/submit_answers/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.onboarding_verifications import onboarding_verifications_submit_answers # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = onboarding_verifications_submit_answers.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: onboarding_verifications_submit_answers
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { onboardingVerificationsSubmitAnswers } from 'waldur-js-client';

try {
  const response = await onboardingVerificationsSubmitAnswers({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: [{"question_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "answer_data": null}]
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

The request body is an array of objects, where each object has the following structure:

Field Type Required
question_uuid string (uuid) ✓
answer_data any ✓

200 -

Field Type Description
uuid string (uuid)
user string (uri) User requesting company onboarding
user_full_name string
country string ISO country code (e.g., 'EE', 'AT') for context. Can be inferred from validation_method.
legal_person_identifier string Official company registration code (required for automatic validation)
legal_name string Company name(optional, for reference)
status any
justifications array of objects
justifications.uuid string (uuid)
justifications.verification string (uri)
justifications.verification_uuid string (uuid)
justifications.country string
justifications.user string (uri)
justifications.user_full_name string
justifications.legal_person_identifier string
justifications.legal_name string
justifications.error_message string
justifications.error_traceback string
justifications.user_justification string User's explanation for why they should be authorized
justifications.validated_by string (uri)
justifications.validated_at string (date-time)
justifications.validation_decision any
justifications.staff_notes string Administrator notes on the review decision
justifications.supporting_documentation array of objects
justifications.supporting_documentation.uuid string (uuid)
justifications.supporting_documentation.file string (uri) Upload supporting documentation.
justifications.supporting_documentation.file_name string
justifications.supporting_documentation.file_size integer
justifications.supporting_documentation.created string (date-time)
justifications.onboarding_metadata object (free-form) Onboarding-specific data like intents, purposes extracted from checklist answers
justifications.user_submitted_customer_data object (free-form) Customer-related data submitted by the user via checklist answers
justifications.created string (date-time)
justifications.modified string (date-time)
validation_method any Method used for validation
verified_user_roles any Roles the user has in the company
verified_company_data any Company information retrieved during validation
raw_response any Raw API response for debugging and auditing
error_traceback string
error_message string
validated_at string (date-time) When validation was completed
expires_at string (date-time) When this verification expires
customer string (uri) Customer created after successful validation
onboarding_metadata object (free-form) Onboarding-specific data like intents, purposes extracted from checklist answers
user_submitted_customer_data object (free-form) Get customer data submitted by the user during onboarding.
can_customer_be_created boolean Boolean indicating if a customer can be created from this verification
customer_creation_error_message string Reason why customer cannot be created (null if can be created)
created string (date-time)
modified string (date-time)

Onboarding

Operations Summary

Method Endpoint Description
GET /api/onboarding/person-identifier-fields/ Person identifier fields
GET /api/onboarding/supported-countries/ Return list of supported countries for validation

Person identifier fields

Return person identifier field specification for a specific validation method. The validation_method parameter should match one of the available methods (e.g., 'ariregister', 'wirtschaftscompass', 'bolagsverket', 'breg').

1
2
3
4
5
http \
  GET \
  https://api.example.com/api/onboarding/person-identifier-fields/ \
  Authorization:"Token YOUR_API_TOKEN" \
  validation_method=="ariregister"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.validation_method_enum import ValidationMethodEnum # (1)
from waldur_api_client.api.onboarding import onboarding_person_identifier_fields_retrieve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = onboarding_person_identifier_fields_retrieve.sync(
    client=client,
    validation_method=ValidationMethodEnum.ARIREGISTER
)

print(response)
  1. Model Source: ValidationMethodEnum
  2. API Source: onboarding_person_identifier_fields_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { onboardingPersonIdentifierFieldsRetrieve } from 'waldur-js-client';

try {
  const response = await onboardingPersonIdentifierFieldsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  query: {
    "validation_method": "ariregister"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
validation_method string ✓ Validation method identifier
Enum: ariregister, wirtschaftscompass, bolagsverket, breg

200 -

Field Type Description
validation_method string The validation method identifier
person_identifier_fields object (free-form) Field specification for person identification. For simple identifiers: {type: 'string', field: 'civil_number', ...}. For composite identifiers: {type: 'object', fields: {...}}

Return list of supported countries for validation

Return list of supported countries for validation.

1
2
3
4
http \
  GET \
  https://api.example.com/api/onboarding/supported-countries/ \
  Authorization:"Token YOUR_API_TOKEN"

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.onboarding import onboarding_supported_countries_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = onboarding_supported_countries_retrieve.sync(client=client)

print(response)
  1. API Source: onboarding_supported_countries_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { onboardingSupportedCountriesRetrieve } from 'waldur-js-client';

try {
  const response = await onboardingSupportedCountriesRetrieve({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

200 -

Field Type
supported_countries array of strings

Policies

Marketplace Customer Component Usage Policies

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/marketplace-customer-component-usage-policies/ List Marketplace Customer Component Usage Policies
GET /api/marketplace-customer-component-usage-policies/{uuid}/ Retrieve
POST /api/marketplace-customer-component-usage-policies/ Create
PUT /api/marketplace-customer-component-usage-policies/{uuid}/ Update
PATCH /api/marketplace-customer-component-usage-policies/{uuid}/ Partial Update
DELETE /api/marketplace-customer-component-usage-policies/{uuid}/ Delete
Other Actions
GET /api/marketplace-customer-component-usage-policies/actions/ List Marketplace Customer Component Usage Policies Actions

Core CRUD

List Marketplace Customer Component Usage Policies

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-customer-component-usage-policies/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_customer_component_usage_policies import marketplace_customer_component_usage_policies_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_customer_component_usage_policies_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: marketplace_customer_component_usage_policies_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceCustomerComponentUsagePoliciesList } from 'waldur-js-client';

try {
  const response = await marketplaceCustomerComponentUsagePoliciesList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
customer string (uri)
customer_uuid string (uuid)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
scope string (uri)
scope_uuid string (uuid)

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid)
url string (uri)
scope string (uri)
scope_name string
scope_uuid string (uuid)
actions string
created string (date-time)
created_by_full_name string
created_by_username string
has_fired boolean
fired_datetime string (date-time)
options any Fields for saving actions extra data. Keys are name of actions.
component_limits_set array of objects
component_limits_set.type string
component_limits_set.limit integer
component_limits_set.period any
component_limits_set.period_name string
component_limits_set.component string (uuid)

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-customer-component-usage-policies/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_customer_component_usage_policies import marketplace_customer_component_usage_policies_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_customer_component_usage_policies_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_customer_component_usage_policies_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceCustomerComponentUsagePoliciesRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceCustomerComponentUsagePoliciesRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
uuid string (uuid)
url string (uri)
scope string (uri)
scope_name string
scope_uuid string (uuid)
actions string
created string (date-time)
created_by_full_name string
created_by_username string
has_fired boolean
fired_datetime string (date-time)
options any Fields for saving actions extra data. Keys are name of actions.
component_limits_set array of objects
component_limits_set.type string
component_limits_set.limit integer
component_limits_set.period any
component_limits_set.period_name string
component_limits_set.component string (uuid)

Create

1
2
3
4
5
6
7
http \
  POST \
  https://api.example.com/api/marketplace-customer-component-usage-policies/ \
  Authorization:"Token YOUR_API_TOKEN" \
  scope="https://api.example.com/api/scope/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  actions="string-value" \
  component_limits_set:='[]'

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.customer_component_usage_policy_request import CustomerComponentUsagePolicyRequest # (1)
from waldur_api_client.api.marketplace_customer_component_usage_policies import marketplace_customer_component_usage_policies_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = CustomerComponentUsagePolicyRequest(
    scope="https://api.example.com/api/scope/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    actions="string-value",
    component_limits_set=[]
)
response = marketplace_customer_component_usage_policies_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: CustomerComponentUsagePolicyRequest
  2. API Source: marketplace_customer_component_usage_policies_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
import { marketplaceCustomerComponentUsagePoliciesCreate } from 'waldur-js-client';

try {
  const response = await marketplaceCustomerComponentUsagePoliciesCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "scope": "https://api.example.com/api/scope/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "actions": "string-value",
    "component_limits_set": []
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
scope string (uri) ✓
actions string ✓
options any Fields for saving actions extra data. Keys are name of actions.
component_limits_set array of objects ✓
component_limits_set.limit integer ✓
component_limits_set.period any
component_limits_set.component string (uuid) ✓

201 -

Field Type Description
uuid string (uuid)
url string (uri)
scope string (uri)
scope_name string
scope_uuid string (uuid)
actions string
created string (date-time)
created_by_full_name string
created_by_username string
has_fired boolean
fired_datetime string (date-time)
options any Fields for saving actions extra data. Keys are name of actions.
component_limits_set array of objects
component_limits_set.type string
component_limits_set.limit integer
component_limits_set.period any
component_limits_set.period_name string
component_limits_set.component string (uuid)

Update

1
2
3
4
5
6
7
http \
  PUT \
  https://api.example.com/api/marketplace-customer-component-usage-policies/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  scope="https://api.example.com/api/scope/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  actions="string-value" \
  component_limits_set:='[]'

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.customer_component_usage_policy_request import CustomerComponentUsagePolicyRequest # (1)
from waldur_api_client.api.marketplace_customer_component_usage_policies import marketplace_customer_component_usage_policies_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = CustomerComponentUsagePolicyRequest(
    scope="https://api.example.com/api/scope/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    actions="string-value",
    component_limits_set=[]
)
response = marketplace_customer_component_usage_policies_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: CustomerComponentUsagePolicyRequest
  2. API Source: marketplace_customer_component_usage_policies_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
import { marketplaceCustomerComponentUsagePoliciesUpdate } from 'waldur-js-client';

try {
  const response = await marketplaceCustomerComponentUsagePoliciesUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "scope": "https://api.example.com/api/scope/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "actions": "string-value",
    "component_limits_set": []
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
scope string (uri) ✓
actions string ✓
options any Fields for saving actions extra data. Keys are name of actions.
component_limits_set array of objects ✓
component_limits_set.limit integer ✓
component_limits_set.period any
component_limits_set.component string (uuid) ✓

200 -

Field Type Description
uuid string (uuid)
url string (uri)
scope string (uri)
scope_name string
scope_uuid string (uuid)
actions string
created string (date-time)
created_by_full_name string
created_by_username string
has_fired boolean
fired_datetime string (date-time)
options any Fields for saving actions extra data. Keys are name of actions.
component_limits_set array of objects
component_limits_set.type string
component_limits_set.limit integer
component_limits_set.period any
component_limits_set.period_name string
component_limits_set.component string (uuid)

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/marketplace-customer-component-usage-policies/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_customer_component_usage_policy_request import PatchedCustomerComponentUsagePolicyRequest # (1)
from waldur_api_client.api.marketplace_customer_component_usage_policies import marketplace_customer_component_usage_policies_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedCustomerComponentUsagePolicyRequest()
response = marketplace_customer_component_usage_policies_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedCustomerComponentUsagePolicyRequest
  2. API Source: marketplace_customer_component_usage_policies_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceCustomerComponentUsagePoliciesPartialUpdate } from 'waldur-js-client';

try {
  const response = await marketplaceCustomerComponentUsagePoliciesPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
scope string (uri)
actions string
options any Fields for saving actions extra data. Keys are name of actions.
component_limits_set array of objects
component_limits_set.limit integer ✓
component_limits_set.period any
component_limits_set.component string (uuid) ✓

200 -

Field Type Description
uuid string (uuid)
url string (uri)
scope string (uri)
scope_name string
scope_uuid string (uuid)
actions string
created string (date-time)
created_by_full_name string
created_by_username string
has_fired boolean
fired_datetime string (date-time)
options any Fields for saving actions extra data. Keys are name of actions.
component_limits_set array of objects
component_limits_set.type string
component_limits_set.limit integer
component_limits_set.period any
component_limits_set.period_name string
component_limits_set.component string (uuid)

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/marketplace-customer-component-usage-policies/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_customer_component_usage_policies import marketplace_customer_component_usage_policies_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_customer_component_usage_policies_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_customer_component_usage_policies_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceCustomerComponentUsagePoliciesDestroy } from 'waldur-js-client';

try {
  const response = await marketplaceCustomerComponentUsagePoliciesDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Other Actions

List Marketplace Customer Component Usage Policies Actions

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-customer-component-usage-policies/actions/ \
  Authorization:"Token YOUR_API_TOKEN"

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_customer_component_usage_policies import marketplace_customer_component_usage_policies_actions_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_customer_component_usage_policies_actions_retrieve.sync(client=client)

print(response)
  1. API Source: marketplace_customer_component_usage_policies_actions_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceCustomerComponentUsagePoliciesActionsRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceCustomerComponentUsagePoliciesActionsRetrieve({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

200 -

Field Type Description
uuid string (uuid)
url string (uri)
scope string (uri)
scope_name string
scope_uuid string (uuid)
actions string
created string (date-time)
created_by_full_name string
created_by_username string
has_fired boolean
fired_datetime string (date-time)
options any Fields for saving actions extra data. Keys are name of actions.
component_limits_set array of objects
component_limits_set.type string
component_limits_set.limit integer
component_limits_set.period any
component_limits_set.period_name string
component_limits_set.component string (uuid)

Marketplace Customer Estimated Cost Policies

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/marketplace-customer-estimated-cost-policies/ List Marketplace Customer Estimated Cost Policies
GET /api/marketplace-customer-estimated-cost-policies/{uuid}/ Retrieve
POST /api/marketplace-customer-estimated-cost-policies/ Create
PUT /api/marketplace-customer-estimated-cost-policies/{uuid}/ Update
PATCH /api/marketplace-customer-estimated-cost-policies/{uuid}/ Partial Update
DELETE /api/marketplace-customer-estimated-cost-policies/{uuid}/ Delete
Other Actions
GET /api/marketplace-customer-estimated-cost-policies/actions/ List Marketplace Customer Estimated Cost Policies Actions

Core CRUD

List Marketplace Customer Estimated Cost Policies

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-customer-estimated-cost-policies/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_customer_estimated_cost_policies import marketplace_customer_estimated_cost_policies_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_customer_estimated_cost_policies_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: marketplace_customer_estimated_cost_policies_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceCustomerEstimatedCostPoliciesList } from 'waldur-js-client';

try {
  const response = await marketplaceCustomerEstimatedCostPoliciesList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
customer string (uri)
customer_uuid string (uuid)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
scope string (uri)
scope_uuid string (uuid)

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid)
url string (uri)
scope string (uri)
scope_name string
scope_uuid string (uuid)
actions string
created string (date-time)
created_by_full_name string
created_by_username string
has_fired boolean
fired_datetime string (date-time)
options any Fields for saving actions extra data. Keys are name of actions.
limit_cost integer
period any
period_name string
customer_credit integer
billing_price_estimate any

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-customer-estimated-cost-policies/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_customer_estimated_cost_policies import marketplace_customer_estimated_cost_policies_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_customer_estimated_cost_policies_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_customer_estimated_cost_policies_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceCustomerEstimatedCostPoliciesRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceCustomerEstimatedCostPoliciesRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
uuid string (uuid)
url string (uri)
scope string (uri)
scope_name string
scope_uuid string (uuid)
actions string
created string (date-time)
created_by_full_name string
created_by_username string
has_fired boolean
fired_datetime string (date-time)
options any Fields for saving actions extra data. Keys are name of actions.
limit_cost integer
period any
period_name string
customer_credit integer
billing_price_estimate any

Create

1
2
3
4
5
6
7
http \
  POST \
  https://api.example.com/api/marketplace-customer-estimated-cost-policies/ \
  Authorization:"Token YOUR_API_TOKEN" \
  scope="https://api.example.com/api/scope/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  actions="string-value" \
  limit_cost=123

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.customer_estimated_cost_policy_request import CustomerEstimatedCostPolicyRequest # (1)
from waldur_api_client.api.marketplace_customer_estimated_cost_policies import marketplace_customer_estimated_cost_policies_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = CustomerEstimatedCostPolicyRequest(
    scope="https://api.example.com/api/scope/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    actions="string-value",
    limit_cost=123
)
response = marketplace_customer_estimated_cost_policies_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: CustomerEstimatedCostPolicyRequest
  2. API Source: marketplace_customer_estimated_cost_policies_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
import { marketplaceCustomerEstimatedCostPoliciesCreate } from 'waldur-js-client';

try {
  const response = await marketplaceCustomerEstimatedCostPoliciesCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "scope": "https://api.example.com/api/scope/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "actions": "string-value",
    "limit_cost": 123
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
scope string (uri) ✓
actions string ✓
options any Fields for saving actions extra data. Keys are name of actions.
limit_cost integer ✓
period any

201 -

Field Type Description
uuid string (uuid)
url string (uri)
scope string (uri)
scope_name string
scope_uuid string (uuid)
actions string
created string (date-time)
created_by_full_name string
created_by_username string
has_fired boolean
fired_datetime string (date-time)
options any Fields for saving actions extra data. Keys are name of actions.
limit_cost integer
period any
period_name string
customer_credit integer
billing_price_estimate any

Update

1
2
3
4
5
6
7
http \
  PUT \
  https://api.example.com/api/marketplace-customer-estimated-cost-policies/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  scope="https://api.example.com/api/scope/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  actions="string-value" \
  limit_cost=123

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.customer_estimated_cost_policy_request import CustomerEstimatedCostPolicyRequest # (1)
from waldur_api_client.api.marketplace_customer_estimated_cost_policies import marketplace_customer_estimated_cost_policies_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = CustomerEstimatedCostPolicyRequest(
    scope="https://api.example.com/api/scope/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    actions="string-value",
    limit_cost=123
)
response = marketplace_customer_estimated_cost_policies_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: CustomerEstimatedCostPolicyRequest
  2. API Source: marketplace_customer_estimated_cost_policies_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
import { marketplaceCustomerEstimatedCostPoliciesUpdate } from 'waldur-js-client';

try {
  const response = await marketplaceCustomerEstimatedCostPoliciesUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "scope": "https://api.example.com/api/scope/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "actions": "string-value",
    "limit_cost": 123
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
scope string (uri) ✓
actions string ✓
options any Fields for saving actions extra data. Keys are name of actions.
limit_cost integer ✓
period any

200 -

Field Type Description
uuid string (uuid)
url string (uri)
scope string (uri)
scope_name string
scope_uuid string (uuid)
actions string
created string (date-time)
created_by_full_name string
created_by_username string
has_fired boolean
fired_datetime string (date-time)
options any Fields for saving actions extra data. Keys are name of actions.
limit_cost integer
period any
period_name string
customer_credit integer
billing_price_estimate any

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/marketplace-customer-estimated-cost-policies/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_customer_estimated_cost_policy_request import PatchedCustomerEstimatedCostPolicyRequest # (1)
from waldur_api_client.api.marketplace_customer_estimated_cost_policies import marketplace_customer_estimated_cost_policies_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedCustomerEstimatedCostPolicyRequest()
response = marketplace_customer_estimated_cost_policies_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedCustomerEstimatedCostPolicyRequest
  2. API Source: marketplace_customer_estimated_cost_policies_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceCustomerEstimatedCostPoliciesPartialUpdate } from 'waldur-js-client';

try {
  const response = await marketplaceCustomerEstimatedCostPoliciesPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
scope string (uri)
actions string
options any Fields for saving actions extra data. Keys are name of actions.
limit_cost integer
period any

200 -

Field Type Description
uuid string (uuid)
url string (uri)
scope string (uri)
scope_name string
scope_uuid string (uuid)
actions string
created string (date-time)
created_by_full_name string
created_by_username string
has_fired boolean
fired_datetime string (date-time)
options any Fields for saving actions extra data. Keys are name of actions.
limit_cost integer
period any
period_name string
customer_credit integer
billing_price_estimate any

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/marketplace-customer-estimated-cost-policies/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_customer_estimated_cost_policies import marketplace_customer_estimated_cost_policies_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_customer_estimated_cost_policies_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_customer_estimated_cost_policies_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceCustomerEstimatedCostPoliciesDestroy } from 'waldur-js-client';

try {
  const response = await marketplaceCustomerEstimatedCostPoliciesDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Other Actions

List Marketplace Customer Estimated Cost Policies Actions

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-customer-estimated-cost-policies/actions/ \
  Authorization:"Token YOUR_API_TOKEN"

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_customer_estimated_cost_policies import marketplace_customer_estimated_cost_policies_actions_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_customer_estimated_cost_policies_actions_retrieve.sync(client=client)

print(response)
  1. API Source: marketplace_customer_estimated_cost_policies_actions_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceCustomerEstimatedCostPoliciesActionsRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceCustomerEstimatedCostPoliciesActionsRetrieve({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

200 -

Field Type Description
uuid string (uuid)
url string (uri)
scope string (uri)
scope_name string
scope_uuid string (uuid)
actions string
created string (date-time)
created_by_full_name string
created_by_username string
has_fired boolean
fired_datetime string (date-time)
options any Fields for saving actions extra data. Keys are name of actions.
limit_cost integer
period any
period_name string
customer_credit integer
billing_price_estimate any

Marketplace Offering Estimated Cost Policies

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/marketplace-offering-estimated-cost-policies/ List Marketplace Offering Estimated Cost Policies
GET /api/marketplace-offering-estimated-cost-policies/{uuid}/ Retrieve
POST /api/marketplace-offering-estimated-cost-policies/ Create
PUT /api/marketplace-offering-estimated-cost-policies/{uuid}/ Update
PATCH /api/marketplace-offering-estimated-cost-policies/{uuid}/ Partial Update
DELETE /api/marketplace-offering-estimated-cost-policies/{uuid}/ Delete
Other Actions
GET /api/marketplace-offering-estimated-cost-policies/actions/ List available actions for OfferingEstimatedCostPolicy

Core CRUD

List Marketplace Offering Estimated Cost Policies

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-offering-estimated-cost-policies/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_offering_estimated_cost_policies import marketplace_offering_estimated_cost_policies_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_offering_estimated_cost_policies_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: marketplace_offering_estimated_cost_policies_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceOfferingEstimatedCostPoliciesList } from 'waldur-js-client';

try {
  const response = await marketplaceOfferingEstimatedCostPoliciesList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
scope string (uri)
scope_uuid string (uuid)

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid)
url string (uri)
scope string (uri)
scope_name string
scope_uuid string (uuid)
actions string
created string (date-time)
created_by_full_name string
created_by_username string
has_fired boolean
fired_datetime string (date-time)
options any Fields for saving actions extra data. Keys are name of actions.
limit_cost integer
period any
period_name string
organization_groups array of string (uri)s
apply_to_all boolean If True, policy applies to all customers. Mutually exclusive with organization_groups.

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-offering-estimated-cost-policies/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_offering_estimated_cost_policies import marketplace_offering_estimated_cost_policies_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_offering_estimated_cost_policies_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_offering_estimated_cost_policies_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceOfferingEstimatedCostPoliciesRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceOfferingEstimatedCostPoliciesRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
uuid string (uuid)
url string (uri)
scope string (uri)
scope_name string
scope_uuid string (uuid)
actions string
created string (date-time)
created_by_full_name string
created_by_username string
has_fired boolean
fired_datetime string (date-time)
options any Fields for saving actions extra data. Keys are name of actions.
limit_cost integer
period any
period_name string
organization_groups array of string (uri)s
apply_to_all boolean If True, policy applies to all customers. Mutually exclusive with organization_groups.

Create

1
2
3
4
5
6
7
http \
  POST \
  https://api.example.com/api/marketplace-offering-estimated-cost-policies/ \
  Authorization:"Token YOUR_API_TOKEN" \
  scope="https://api.example.com/api/scope/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  actions="string-value" \
  limit_cost=123

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.offering_estimated_cost_policy_request import OfferingEstimatedCostPolicyRequest # (1)
from waldur_api_client.api.marketplace_offering_estimated_cost_policies import marketplace_offering_estimated_cost_policies_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OfferingEstimatedCostPolicyRequest(
    scope="https://api.example.com/api/scope/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    actions="string-value",
    limit_cost=123
)
response = marketplace_offering_estimated_cost_policies_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OfferingEstimatedCostPolicyRequest
  2. API Source: marketplace_offering_estimated_cost_policies_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
import { marketplaceOfferingEstimatedCostPoliciesCreate } from 'waldur-js-client';

try {
  const response = await marketplaceOfferingEstimatedCostPoliciesCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "scope": "https://api.example.com/api/scope/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "actions": "string-value",
    "limit_cost": 123
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
scope string (uri) ✓
actions string ✓
options any Fields for saving actions extra data. Keys are name of actions.
limit_cost integer ✓
period any
organization_groups array of string (uri)s
apply_to_all boolean If True, policy applies to all customers. Mutually exclusive with organization_groups.

201 -

Field Type Description
uuid string (uuid)
url string (uri)
scope string (uri)
scope_name string
scope_uuid string (uuid)
actions string
created string (date-time)
created_by_full_name string
created_by_username string
has_fired boolean
fired_datetime string (date-time)
options any Fields for saving actions extra data. Keys are name of actions.
limit_cost integer
period any
period_name string
organization_groups array of string (uri)s
apply_to_all boolean If True, policy applies to all customers. Mutually exclusive with organization_groups.

Update

1
2
3
4
5
6
7
http \
  PUT \
  https://api.example.com/api/marketplace-offering-estimated-cost-policies/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  scope="https://api.example.com/api/scope/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  actions="string-value" \
  limit_cost=123

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.offering_estimated_cost_policy_request import OfferingEstimatedCostPolicyRequest # (1)
from waldur_api_client.api.marketplace_offering_estimated_cost_policies import marketplace_offering_estimated_cost_policies_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OfferingEstimatedCostPolicyRequest(
    scope="https://api.example.com/api/scope/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    actions="string-value",
    limit_cost=123
)
response = marketplace_offering_estimated_cost_policies_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OfferingEstimatedCostPolicyRequest
  2. API Source: marketplace_offering_estimated_cost_policies_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
import { marketplaceOfferingEstimatedCostPoliciesUpdate } from 'waldur-js-client';

try {
  const response = await marketplaceOfferingEstimatedCostPoliciesUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "scope": "https://api.example.com/api/scope/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "actions": "string-value",
    "limit_cost": 123
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
scope string (uri) ✓
actions string ✓
options any Fields for saving actions extra data. Keys are name of actions.
limit_cost integer ✓
period any
organization_groups array of string (uri)s
apply_to_all boolean If True, policy applies to all customers. Mutually exclusive with organization_groups.

200 -

Field Type Description
uuid string (uuid)
url string (uri)
scope string (uri)
scope_name string
scope_uuid string (uuid)
actions string
created string (date-time)
created_by_full_name string
created_by_username string
has_fired boolean
fired_datetime string (date-time)
options any Fields for saving actions extra data. Keys are name of actions.
limit_cost integer
period any
period_name string
organization_groups array of string (uri)s
apply_to_all boolean If True, policy applies to all customers. Mutually exclusive with organization_groups.

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/marketplace-offering-estimated-cost-policies/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_offering_estimated_cost_policy_request import PatchedOfferingEstimatedCostPolicyRequest # (1)
from waldur_api_client.api.marketplace_offering_estimated_cost_policies import marketplace_offering_estimated_cost_policies_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedOfferingEstimatedCostPolicyRequest()
response = marketplace_offering_estimated_cost_policies_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedOfferingEstimatedCostPolicyRequest
  2. API Source: marketplace_offering_estimated_cost_policies_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceOfferingEstimatedCostPoliciesPartialUpdate } from 'waldur-js-client';

try {
  const response = await marketplaceOfferingEstimatedCostPoliciesPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
scope string (uri)
actions string
options any Fields for saving actions extra data. Keys are name of actions.
limit_cost integer
period any
organization_groups array of string (uri)s
apply_to_all boolean If True, policy applies to all customers. Mutually exclusive with organization_groups.

200 -

Field Type Description
uuid string (uuid)
url string (uri)
scope string (uri)
scope_name string
scope_uuid string (uuid)
actions string
created string (date-time)
created_by_full_name string
created_by_username string
has_fired boolean
fired_datetime string (date-time)
options any Fields for saving actions extra data. Keys are name of actions.
limit_cost integer
period any
period_name string
organization_groups array of string (uri)s
apply_to_all boolean If True, policy applies to all customers. Mutually exclusive with organization_groups.

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/marketplace-offering-estimated-cost-policies/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_offering_estimated_cost_policies import marketplace_offering_estimated_cost_policies_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_offering_estimated_cost_policies_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_offering_estimated_cost_policies_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceOfferingEstimatedCostPoliciesDestroy } from 'waldur-js-client';

try {
  const response = await marketplaceOfferingEstimatedCostPoliciesDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Other Actions

List available actions for OfferingEstimatedCostPolicy

List available actions for OfferingEstimatedCostPolicy

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-offering-estimated-cost-policies/actions/ \
  Authorization:"Token YOUR_API_TOKEN"

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_offering_estimated_cost_policies import marketplace_offering_estimated_cost_policies_actions_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_offering_estimated_cost_policies_actions_retrieve.sync(client=client)

print(response)
  1. API Source: marketplace_offering_estimated_cost_policies_actions_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceOfferingEstimatedCostPoliciesActionsRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceOfferingEstimatedCostPoliciesActionsRetrieve({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

200 -

Field Type Description
uuid string (uuid)
url string (uri)
scope string (uri)
scope_name string
scope_uuid string (uuid)
actions string
created string (date-time)
created_by_full_name string
created_by_username string
has_fired boolean
fired_datetime string (date-time)
options any Fields for saving actions extra data. Keys are name of actions.
limit_cost integer
period any
period_name string
organization_groups array of string (uri)s
apply_to_all boolean If True, policy applies to all customers. Mutually exclusive with organization_groups.

Marketplace Offering Usage Policies

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/marketplace-offering-usage-policies/ List Marketplace Offering Usage Policies
GET /api/marketplace-offering-usage-policies/{uuid}/ Retrieve
POST /api/marketplace-offering-usage-policies/ Create
PUT /api/marketplace-offering-usage-policies/{uuid}/ Update
PATCH /api/marketplace-offering-usage-policies/{uuid}/ Partial Update
DELETE /api/marketplace-offering-usage-policies/{uuid}/ Delete
Other Actions
GET /api/marketplace-offering-usage-policies/actions/ List Marketplace Offering Usage Policies Actions

Core CRUD

List Marketplace Offering Usage Policies

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-offering-usage-policies/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_offering_usage_policies import marketplace_offering_usage_policies_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_offering_usage_policies_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: marketplace_offering_usage_policies_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceOfferingUsagePoliciesList } from 'waldur-js-client';

try {
  const response = await marketplaceOfferingUsagePoliciesList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
scope string (uri)
scope_uuid string (uuid)

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid)
url string (uri)
scope string (uri)
scope_name string
scope_uuid string (uuid)
actions string
created string (date-time)
created_by_full_name string
created_by_username string
has_fired boolean
fired_datetime string (date-time)
options any Fields for saving actions extra data. Keys are name of actions.
organization_groups array of string (uri)s
apply_to_all boolean If True, policy applies to all customers. Mutually exclusive with organization_groups.
component_limits_set array of objects
component_limits_set.type string
component_limits_set.limit integer
period any
period_name string

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-offering-usage-policies/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_offering_usage_policies import marketplace_offering_usage_policies_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_offering_usage_policies_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_offering_usage_policies_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceOfferingUsagePoliciesRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceOfferingUsagePoliciesRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
uuid string (uuid)
url string (uri)
scope string (uri)
scope_name string
scope_uuid string (uuid)
actions string
created string (date-time)
created_by_full_name string
created_by_username string
has_fired boolean
fired_datetime string (date-time)
options any Fields for saving actions extra data. Keys are name of actions.
organization_groups array of string (uri)s
apply_to_all boolean If True, policy applies to all customers. Mutually exclusive with organization_groups.
component_limits_set array of objects
component_limits_set.type string
component_limits_set.limit integer
period any
period_name string

Create

1
2
3
4
5
6
7
http \
  POST \
  https://api.example.com/api/marketplace-offering-usage-policies/ \
  Authorization:"Token YOUR_API_TOKEN" \
  scope="https://api.example.com/api/scope/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  actions="string-value" \
  component_limits_set:='[]'

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.offering_usage_policy_request import OfferingUsagePolicyRequest # (1)
from waldur_api_client.api.marketplace_offering_usage_policies import marketplace_offering_usage_policies_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OfferingUsagePolicyRequest(
    scope="https://api.example.com/api/scope/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    actions="string-value",
    component_limits_set=[]
)
response = marketplace_offering_usage_policies_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OfferingUsagePolicyRequest
  2. API Source: marketplace_offering_usage_policies_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
import { marketplaceOfferingUsagePoliciesCreate } from 'waldur-js-client';

try {
  const response = await marketplaceOfferingUsagePoliciesCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "scope": "https://api.example.com/api/scope/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "actions": "string-value",
    "component_limits_set": []
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
scope string (uri) ✓
actions string ✓
options any Fields for saving actions extra data. Keys are name of actions.
organization_groups array of string (uri)s
apply_to_all boolean If True, policy applies to all customers. Mutually exclusive with organization_groups.
component_limits_set array of objects ✓
component_limits_set.type string ✓
component_limits_set.limit integer ✓
period any

201 -

Field Type Description
uuid string (uuid)
url string (uri)
scope string (uri)
scope_name string
scope_uuid string (uuid)
actions string
created string (date-time)
created_by_full_name string
created_by_username string
has_fired boolean
fired_datetime string (date-time)
options any Fields for saving actions extra data. Keys are name of actions.
organization_groups array of string (uri)s
apply_to_all boolean If True, policy applies to all customers. Mutually exclusive with organization_groups.
component_limits_set array of objects
component_limits_set.type string
component_limits_set.limit integer
period any
period_name string

Update

1
2
3
4
5
6
7
http \
  PUT \
  https://api.example.com/api/marketplace-offering-usage-policies/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  scope="https://api.example.com/api/scope/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  actions="string-value" \
  component_limits_set:='[]'

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.offering_usage_policy_request import OfferingUsagePolicyRequest # (1)
from waldur_api_client.api.marketplace_offering_usage_policies import marketplace_offering_usage_policies_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OfferingUsagePolicyRequest(
    scope="https://api.example.com/api/scope/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    actions="string-value",
    component_limits_set=[]
)
response = marketplace_offering_usage_policies_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OfferingUsagePolicyRequest
  2. API Source: marketplace_offering_usage_policies_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
import { marketplaceOfferingUsagePoliciesUpdate } from 'waldur-js-client';

try {
  const response = await marketplaceOfferingUsagePoliciesUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "scope": "https://api.example.com/api/scope/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "actions": "string-value",
    "component_limits_set": []
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
scope string (uri) ✓
actions string ✓
options any Fields for saving actions extra data. Keys are name of actions.
organization_groups array of string (uri)s
apply_to_all boolean If True, policy applies to all customers. Mutually exclusive with organization_groups.
component_limits_set array of objects ✓
component_limits_set.type string ✓
component_limits_set.limit integer ✓
period any

200 -

Field Type Description
uuid string (uuid)
url string (uri)
scope string (uri)
scope_name string
scope_uuid string (uuid)
actions string
created string (date-time)
created_by_full_name string
created_by_username string
has_fired boolean
fired_datetime string (date-time)
options any Fields for saving actions extra data. Keys are name of actions.
organization_groups array of string (uri)s
apply_to_all boolean If True, policy applies to all customers. Mutually exclusive with organization_groups.
component_limits_set array of objects
component_limits_set.type string
component_limits_set.limit integer
period any
period_name string

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/marketplace-offering-usage-policies/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_offering_usage_policy_request import PatchedOfferingUsagePolicyRequest # (1)
from waldur_api_client.api.marketplace_offering_usage_policies import marketplace_offering_usage_policies_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedOfferingUsagePolicyRequest()
response = marketplace_offering_usage_policies_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedOfferingUsagePolicyRequest
  2. API Source: marketplace_offering_usage_policies_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceOfferingUsagePoliciesPartialUpdate } from 'waldur-js-client';

try {
  const response = await marketplaceOfferingUsagePoliciesPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
scope string (uri)
actions string
options any Fields for saving actions extra data. Keys are name of actions.
organization_groups array of string (uri)s
apply_to_all boolean If True, policy applies to all customers. Mutually exclusive with organization_groups.
component_limits_set array of objects
component_limits_set.type string ✓
component_limits_set.limit integer ✓
period any

200 -

Field Type Description
uuid string (uuid)
url string (uri)
scope string (uri)
scope_name string
scope_uuid string (uuid)
actions string
created string (date-time)
created_by_full_name string
created_by_username string
has_fired boolean
fired_datetime string (date-time)
options any Fields for saving actions extra data. Keys are name of actions.
organization_groups array of string (uri)s
apply_to_all boolean If True, policy applies to all customers. Mutually exclusive with organization_groups.
component_limits_set array of objects
component_limits_set.type string
component_limits_set.limit integer
period any
period_name string

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/marketplace-offering-usage-policies/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_offering_usage_policies import marketplace_offering_usage_policies_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_offering_usage_policies_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_offering_usage_policies_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceOfferingUsagePoliciesDestroy } from 'waldur-js-client';

try {
  const response = await marketplaceOfferingUsagePoliciesDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Other Actions

List Marketplace Offering Usage Policies Actions

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-offering-usage-policies/actions/ \
  Authorization:"Token YOUR_API_TOKEN"

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_offering_usage_policies import marketplace_offering_usage_policies_actions_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_offering_usage_policies_actions_retrieve.sync(client=client)

print(response)
  1. API Source: marketplace_offering_usage_policies_actions_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceOfferingUsagePoliciesActionsRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceOfferingUsagePoliciesActionsRetrieve({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

200 -

Field Type Description
uuid string (uuid)
url string (uri)
scope string (uri)
scope_name string
scope_uuid string (uuid)
actions string
created string (date-time)
created_by_full_name string
created_by_username string
has_fired boolean
fired_datetime string (date-time)
options any Fields for saving actions extra data. Keys are name of actions.
organization_groups array of string (uri)s
apply_to_all boolean If True, policy applies to all customers. Mutually exclusive with organization_groups.
component_limits_set array of objects
component_limits_set.type string
component_limits_set.limit integer
period any
period_name string

Marketplace Project Estimated Cost Policies

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/marketplace-project-estimated-cost-policies/ List Marketplace Project Estimated Cost Policies
GET /api/marketplace-project-estimated-cost-policies/{uuid}/ Retrieve
POST /api/marketplace-project-estimated-cost-policies/ Create
PUT /api/marketplace-project-estimated-cost-policies/{uuid}/ Update
PATCH /api/marketplace-project-estimated-cost-policies/{uuid}/ Partial Update
DELETE /api/marketplace-project-estimated-cost-policies/{uuid}/ Delete
Other Actions
GET /api/marketplace-project-estimated-cost-policies/actions/ List Marketplace Project Estimated Cost Policies Actions

Core CRUD

List Marketplace Project Estimated Cost Policies

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-project-estimated-cost-policies/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_project_estimated_cost_policies import marketplace_project_estimated_cost_policies_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_project_estimated_cost_policies_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: marketplace_project_estimated_cost_policies_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceProjectEstimatedCostPoliciesList } from 'waldur-js-client';

try {
  const response = await marketplaceProjectEstimatedCostPoliciesList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
customer string (uri)
customer_uuid string (uuid)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
project string (uri)
project_uuid string (uuid)
scope string (uri)
scope_uuid string (uuid)

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid)
url string (uri)
scope string (uri)
scope_name string
scope_uuid string (uuid)
actions string
created string (date-time)
created_by_full_name string
created_by_username string
has_fired boolean
fired_datetime string (date-time)
options any Fields for saving actions extra data. Keys are name of actions.
limit_cost integer
period any
period_name string
project_credit number (double)
customer_credit number (double)
billing_price_estimate any

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-project-estimated-cost-policies/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_project_estimated_cost_policies import marketplace_project_estimated_cost_policies_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_project_estimated_cost_policies_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_project_estimated_cost_policies_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceProjectEstimatedCostPoliciesRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceProjectEstimatedCostPoliciesRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
uuid string (uuid)
url string (uri)
scope string (uri)
scope_name string
scope_uuid string (uuid)
actions string
created string (date-time)
created_by_full_name string
created_by_username string
has_fired boolean
fired_datetime string (date-time)
options any Fields for saving actions extra data. Keys are name of actions.
limit_cost integer
period any
period_name string
project_credit number (double)
customer_credit number (double)
billing_price_estimate any

Create

1
2
3
4
5
6
7
http \
  POST \
  https://api.example.com/api/marketplace-project-estimated-cost-policies/ \
  Authorization:"Token YOUR_API_TOKEN" \
  scope="https://api.example.com/api/scope/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  actions="string-value" \
  limit_cost=123

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.project_estimated_cost_policy_request import ProjectEstimatedCostPolicyRequest # (1)
from waldur_api_client.api.marketplace_project_estimated_cost_policies import marketplace_project_estimated_cost_policies_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ProjectEstimatedCostPolicyRequest(
    scope="https://api.example.com/api/scope/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    actions="string-value",
    limit_cost=123
)
response = marketplace_project_estimated_cost_policies_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ProjectEstimatedCostPolicyRequest
  2. API Source: marketplace_project_estimated_cost_policies_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
import { marketplaceProjectEstimatedCostPoliciesCreate } from 'waldur-js-client';

try {
  const response = await marketplaceProjectEstimatedCostPoliciesCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "scope": "https://api.example.com/api/scope/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "actions": "string-value",
    "limit_cost": 123
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
scope string (uri) ✓
actions string ✓
options any Fields for saving actions extra data. Keys are name of actions.
limit_cost integer ✓
period any

201 -

Field Type Description
uuid string (uuid)
url string (uri)
scope string (uri)
scope_name string
scope_uuid string (uuid)
actions string
created string (date-time)
created_by_full_name string
created_by_username string
has_fired boolean
fired_datetime string (date-time)
options any Fields for saving actions extra data. Keys are name of actions.
limit_cost integer
period any
period_name string
project_credit number (double)
customer_credit number (double)
billing_price_estimate any

Update

1
2
3
4
5
6
7
http \
  PUT \
  https://api.example.com/api/marketplace-project-estimated-cost-policies/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  scope="https://api.example.com/api/scope/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  actions="string-value" \
  limit_cost=123

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.project_estimated_cost_policy_request import ProjectEstimatedCostPolicyRequest # (1)
from waldur_api_client.api.marketplace_project_estimated_cost_policies import marketplace_project_estimated_cost_policies_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ProjectEstimatedCostPolicyRequest(
    scope="https://api.example.com/api/scope/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    actions="string-value",
    limit_cost=123
)
response = marketplace_project_estimated_cost_policies_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ProjectEstimatedCostPolicyRequest
  2. API Source: marketplace_project_estimated_cost_policies_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
import { marketplaceProjectEstimatedCostPoliciesUpdate } from 'waldur-js-client';

try {
  const response = await marketplaceProjectEstimatedCostPoliciesUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "scope": "https://api.example.com/api/scope/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "actions": "string-value",
    "limit_cost": 123
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
scope string (uri) ✓
actions string ✓
options any Fields for saving actions extra data. Keys are name of actions.
limit_cost integer ✓
period any

200 -

Field Type Description
uuid string (uuid)
url string (uri)
scope string (uri)
scope_name string
scope_uuid string (uuid)
actions string
created string (date-time)
created_by_full_name string
created_by_username string
has_fired boolean
fired_datetime string (date-time)
options any Fields for saving actions extra data. Keys are name of actions.
limit_cost integer
period any
period_name string
project_credit number (double)
customer_credit number (double)
billing_price_estimate any

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/marketplace-project-estimated-cost-policies/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_project_estimated_cost_policy_request import PatchedProjectEstimatedCostPolicyRequest # (1)
from waldur_api_client.api.marketplace_project_estimated_cost_policies import marketplace_project_estimated_cost_policies_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedProjectEstimatedCostPolicyRequest()
response = marketplace_project_estimated_cost_policies_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedProjectEstimatedCostPolicyRequest
  2. API Source: marketplace_project_estimated_cost_policies_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceProjectEstimatedCostPoliciesPartialUpdate } from 'waldur-js-client';

try {
  const response = await marketplaceProjectEstimatedCostPoliciesPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
scope string (uri)
actions string
options any Fields for saving actions extra data. Keys are name of actions.
limit_cost integer
period any

200 -

Field Type Description
uuid string (uuid)
url string (uri)
scope string (uri)
scope_name string
scope_uuid string (uuid)
actions string
created string (date-time)
created_by_full_name string
created_by_username string
has_fired boolean
fired_datetime string (date-time)
options any Fields for saving actions extra data. Keys are name of actions.
limit_cost integer
period any
period_name string
project_credit number (double)
customer_credit number (double)
billing_price_estimate any

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/marketplace-project-estimated-cost-policies/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_project_estimated_cost_policies import marketplace_project_estimated_cost_policies_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_project_estimated_cost_policies_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_project_estimated_cost_policies_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceProjectEstimatedCostPoliciesDestroy } from 'waldur-js-client';

try {
  const response = await marketplaceProjectEstimatedCostPoliciesDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Other Actions

List Marketplace Project Estimated Cost Policies Actions

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-project-estimated-cost-policies/actions/ \
  Authorization:"Token YOUR_API_TOKEN"

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_project_estimated_cost_policies import marketplace_project_estimated_cost_policies_actions_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_project_estimated_cost_policies_actions_retrieve.sync(client=client)

print(response)
  1. API Source: marketplace_project_estimated_cost_policies_actions_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceProjectEstimatedCostPoliciesActionsRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceProjectEstimatedCostPoliciesActionsRetrieve({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

200 -

Field Type Description
uuid string (uuid)
url string (uri)
scope string (uri)
scope_name string
scope_uuid string (uuid)
actions string
created string (date-time)
created_by_full_name string
created_by_username string
has_fired boolean
fired_datetime string (date-time)
options any Fields for saving actions extra data. Keys are name of actions.
limit_cost integer
period any
period_name string
project_credit number (double)
customer_credit number (double)
billing_price_estimate any

Promotions

Promotions Campaigns

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/promotions-campaigns/ List Promotions Campaigns
GET /api/promotions-campaigns/{uuid}/ Retrieve
POST /api/promotions-campaigns/ Create
PUT /api/promotions-campaigns/{uuid}/ Update
DELETE /api/promotions-campaigns/{uuid}/ Delete
Other Actions
GET /api/promotions-campaigns/{uuid}/orders/ Return a list of orders for which the campaign is applied
GET /api/promotions-campaigns/{uuid}/resources/ Return a list of resources for which the campaign is applied
POST /api/promotions-campaigns/{uuid}/activate/ Activate campaign
POST /api/promotions-campaigns/{uuid}/terminate/ Terminate campaign

Core CRUD

List Promotions Campaigns

1
2
3
4
http \
  GET \
  https://api.example.com/api/promotions-campaigns/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.campaign_o_enum import CampaignOEnum # (1)
from waldur_api_client.models.campaign_state_enum import CampaignStateEnum # (2)
from waldur_api_client.api.promotions_campaigns import promotions_campaigns_list # (3)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = promotions_campaigns_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: CampaignOEnum
  2. Model Source: CampaignStateEnum
  3. API Source: promotions_campaigns_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { promotionsCampaignsList } from 'waldur-js-client';

try {
  const response = await promotionsCampaignsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
discount_type string
end_date string (date)
o array Ordering
offering string (uri) Offering
offering_uuid string (uuid)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
query string Search by name or coupon code
service_provider_uuid string (uuid)
start_date string (date)
state array

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid)
name string
url string (uri)
start_date string (date) Starting from this date, the campaign is active.
end_date string (date) The last day the campaign is active.
coupon string If coupon is empty, campaign is available to all users.
discount_type string
Enum: discount, special_price
discount integer
stock integer
description string
months integer How many months in a row should the related service (when activated) get special deal (0 for indefinitely until active)
auto_apply boolean
state string
service_provider string (uri)
offerings array of objects
offerings.uuid string (uuid)
offerings.name string
required_offerings array of string (uuid)s

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/promotions-campaigns/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.promotions_campaigns import promotions_campaigns_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = promotions_campaigns_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: promotions_campaigns_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { promotionsCampaignsRetrieve } from 'waldur-js-client';

try {
  const response = await promotionsCampaignsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
uuid string (uuid)
name string
url string (uri)
start_date string (date) Starting from this date, the campaign is active.
end_date string (date) The last day the campaign is active.
coupon string If coupon is empty, campaign is available to all users.
discount_type string
Enum: discount, special_price
discount integer
stock integer
description string
months integer How many months in a row should the related service (when activated) get special deal (0 for indefinitely until active)
auto_apply boolean
state string
service_provider string (uri)
offerings array of objects
offerings.uuid string (uuid)
offerings.name string
required_offerings array of string (uuid)s

Create

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
http \
  POST \
  https://api.example.com/api/promotions-campaigns/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-promotions-campaign" \
  start_date="2023-10-01" \
  end_date="2023-10-01" \
  discount_type="discount" \
  discount=123 \
  service_provider="https://api.example.com/api/service-provider/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  offerings:='[]'

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.campaign_request import CampaignRequest # (1)
from waldur_api_client.api.promotions_campaigns import promotions_campaigns_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = CampaignRequest(
    name="my-awesome-promotions-campaign",
    start_date="2023-10-01",
    end_date="2023-10-01",
    discount_type="discount",
    discount=123,
    service_provider="https://api.example.com/api/service-provider/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    offerings=[]
)
response = promotions_campaigns_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: CampaignRequest
  2. API Source: promotions_campaigns_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
import { promotionsCampaignsCreate } from 'waldur-js-client';

try {
  const response = await promotionsCampaignsCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "name": "my-awesome-promotions-campaign",
    "start_date": "2023-10-01",
    "end_date": "2023-10-01",
    "discount_type": "discount",
    "discount": 123,
    "service_provider": "https://api.example.com/api/service-provider/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "offerings": []
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
name string ✓
start_date string (date) ✓ Starting from this date, the campaign is active.
end_date string (date) ✓ The last day the campaign is active.
coupon string If coupon is empty, campaign is available to all users.
discount_type string ✓
Enum: discount, special_price
discount integer ✓
stock integer
description string
months integer How many months in a row should the related service (when activated) get special deal (0 for indefinitely until active)
auto_apply boolean
service_provider string (uri) ✓
offerings array of string (uuid)s ✓
Constraints: write-only
required_offerings array of string (uuid)s

201 -

Field Type Description
uuid string (uuid)
name string
url string (uri)
start_date string (date) Starting from this date, the campaign is active.
end_date string (date) The last day the campaign is active.
coupon string If coupon is empty, campaign is available to all users.
discount_type string
Enum: discount, special_price
discount integer
stock integer
description string
months integer How many months in a row should the related service (when activated) get special deal (0 for indefinitely until active)
auto_apply boolean
state string
service_provider string (uri)
offerings array of objects
offerings.uuid string (uuid)
offerings.name string
required_offerings array of string (uuid)s

Update

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
http \
  PUT \
  https://api.example.com/api/promotions-campaigns/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-promotions-campaign" \
  start_date="2023-10-01" \
  end_date="2023-10-01" \
  discount_type="discount" \
  discount=123 \
  service_provider="https://api.example.com/api/service-provider/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  offerings:='[]'

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.campaign_request import CampaignRequest # (1)
from waldur_api_client.api.promotions_campaigns import promotions_campaigns_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = CampaignRequest(
    name="my-awesome-promotions-campaign",
    start_date="2023-10-01",
    end_date="2023-10-01",
    discount_type="discount",
    discount=123,
    service_provider="https://api.example.com/api/service-provider/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    offerings=[]
)
response = promotions_campaigns_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: CampaignRequest
  2. API Source: promotions_campaigns_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
import { promotionsCampaignsUpdate } from 'waldur-js-client';

try {
  const response = await promotionsCampaignsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-promotions-campaign",
    "start_date": "2023-10-01",
    "end_date": "2023-10-01",
    "discount_type": "discount",
    "discount": 123,
    "service_provider": "https://api.example.com/api/service-provider/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "offerings": []
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
name string ✓
start_date string (date) ✓ Starting from this date, the campaign is active.
end_date string (date) ✓ The last day the campaign is active.
coupon string If coupon is empty, campaign is available to all users.
discount_type string ✓
Enum: discount, special_price
discount integer ✓
stock integer
description string
months integer How many months in a row should the related service (when activated) get special deal (0 for indefinitely until active)
auto_apply boolean
service_provider string (uri) ✓
offerings array of string (uuid)s ✓
Constraints: write-only
required_offerings array of string (uuid)s

200 -

Field Type Description
uuid string (uuid)
name string
url string (uri)
start_date string (date) Starting from this date, the campaign is active.
end_date string (date) The last day the campaign is active.
coupon string If coupon is empty, campaign is available to all users.
discount_type string
Enum: discount, special_price
discount integer
stock integer
description string
months integer How many months in a row should the related service (when activated) get special deal (0 for indefinitely until active)
auto_apply boolean
state string
service_provider string (uri)
offerings array of objects
offerings.uuid string (uuid)
offerings.name string
required_offerings array of string (uuid)s

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/promotions-campaigns/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.promotions_campaigns import promotions_campaigns_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = promotions_campaigns_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: promotions_campaigns_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { promotionsCampaignsDestroy } from 'waldur-js-client';

try {
  const response = await promotionsCampaignsDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Other Actions

Return a list of orders for which the campaign is applied

Return a list of orders for which the campaign is applied.

1
2
3
4
http \
  GET \
  https://api.example.com/api/promotions-campaigns/a1b2c3d4-e5f6-7890-abcd-ef1234567890/orders/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.order_details_field_enum import OrderDetailsFieldEnum # (1)
from waldur_api_client.api.promotions_campaigns import promotions_campaigns_orders_list # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = promotions_campaigns_orders_list.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

for item in response:
    print(item)
  1. Model Source: OrderDetailsFieldEnum
  2. API Source: promotions_campaigns_orders_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { promotionsCampaignsOrdersList } from 'waldur-js-client';

try {
  const response = await promotionsCampaignsOrdersList({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type Description
field array
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
offering string (uri)
offering_name string
offering_uuid string (uuid)
offering_description string
offering_image string (uri)
offering_thumbnail string (uri)
offering_type string
offering_shared boolean Accessible to all customers.
offering_billable boolean Purchase and usage is invoiced.
offering_plugin_options any Public data used by specific plugin, such as storage mode for OpenStack.
provider_name string
provider_uuid string (uuid)
provider_slug string
category_title string
category_uuid string (uuid)
category_icon string (uri)
plan string (uri)
plan_unit any
plan_name string
plan_uuid string (uuid)
plan_description string
attributes any
limits object (free-form)
uuid string (uuid)
created string (date-time)
modified string (date-time)
resource_uuid string (uuid)
resource_type string
resource_name string
cost string (decimal)
state any
output string
marketplace_resource_uuid string (uuid)
error_message string
error_traceback string
callback_url string (uri)
completed_at string (date-time)
request_comment string
attachment string (uri)
type any
start_date string (date) Enables delayed processing of resource provisioning order.
slug string
url string (uri)
consumer_reviewed_by string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
consumer_reviewed_by_full_name string
consumer_reviewed_by_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
consumer_reviewed_at string (date-time)
provider_reviewed_by string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
provider_reviewed_by_full_name string
provider_reviewed_by_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
provider_reviewed_at string (date-time)
created_by_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
created_by_full_name string
created_by_civil_number string
created_by_email string (email)
created_by_organization string
created_by_organization_registry_code string Company registration code of the user's organization, if known
customer_name string
customer_uuid string (uuid)
customer_slug string
project_name string
project_uuid string (uuid)
project_description string
project_slug string
old_plan_name string
new_plan_name string
old_plan_uuid string (uuid)
new_plan_uuid string (uuid)
old_cost_estimate number (double)
new_cost_estimate string (decimal)
can_terminate boolean
fixed_price number (double)
activation_price number (double)
termination_comment string
backend_id string
order_subtype string
provider_message string
provider_message_url string (uri)
provider_message_attachment string (uri)
consumer_message string
consumer_message_attachment string (uri)
consumer_rejection_comment string
provider_rejection_comment string
issue any

Return a list of resources for which the campaign is applied

Return a list of resources for which the campaign is applied.

1
2
3
4
http \
  GET \
  https://api.example.com/api/promotions-campaigns/a1b2c3d4-e5f6-7890-abcd-ef1234567890/resources/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.resource_field_enum import ResourceFieldEnum # (1)
from waldur_api_client.api.promotions_campaigns import promotions_campaigns_resources_list # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = promotions_campaigns_resources_list.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

for item in response:
    print(item)
  1. Model Source: ResourceFieldEnum
  2. API Source: promotions_campaigns_resources_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { promotionsCampaignsResourcesList } from 'waldur-js-client';

try {
  const response = await promotionsCampaignsResourcesList({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type Description
field array
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
offering string (uri)
offering_name string
offering_uuid string (uuid)
offering_description string
offering_image string (uri)
offering_thumbnail string (uri)
offering_type string
offering_shared boolean Accessible to all customers.
offering_billable boolean Purchase and usage is invoiced.
offering_plugin_options any Public data used by specific plugin, such as storage mode for OpenStack.
provider_name string
provider_uuid string (uuid)
provider_slug string
category_title string
category_uuid string (uuid)
category_icon string (uri)
plan string (uri)
plan_unit any
plan_name string
plan_uuid string (uuid)
plan_description string
attributes object (free-form)
limits object (free-form)
uuid string (uuid)
created string (date-time)
modified string (date-time)
url string (uri)
scope string
description string
state any
resource_uuid string (uuid)
backend_id string
effective_id string
resource_type string
project string (uri)
project_uuid string (uuid)
project_name string
project_description string
project_end_date string (date) The date is inclusive. Once reached, all project resource will be scheduled for termination.
project_end_date_requested_by string (uri)
customer_uuid string (uuid)
customer_name string
offering_slug string
parent_offering_uuid string (uuid)
parent_offering_name string
parent_offering_slug string
offering_backend_id string
parent_uuid string (uuid)
parent_name string
backend_metadata any
is_usage_based boolean Returns True if the resource has usage-based components that track variable consumption.
is_limit_based boolean Returns True if the resource has limit-based components with user-adjustable quotas.
name string
slug string URL-friendly identifier. Only editable by staff users.
current_usages object (free-form) Dictionary mapping component types to their latest reported usage amounts.
can_terminate boolean
report array of objects
report.header string Section header text
report.body string Section body content
end_date string (date) The date is inclusive. Once reached, a resource will be scheduled for termination.
end_date_requested_by string (uri)
username string
limit_usage object (free-form) Dictionary mapping limit-based component types to their consumed usage. For monthly periods, maps from current_usages; for longer periods, aggregates historical usage.
downscaled boolean
restrict_member_access boolean
paused boolean
endpoints array of objects
endpoints.uuid string (uuid)
endpoints.name string
endpoints.url string URL of the access endpoint
error_message string
error_traceback string
options any
available_actions array of strings
last_sync string (date-time)
order_in_progress any
creation_order any
service_settings_uuid string (uuid)
project_slug string
customer_slug string
user_requires_reconsent boolean Check if the current user needs to re-consent for this resource's offering.
renewal_date object (free-form)
offering_state any
offering_components array of objects
offering_components.uuid string (uuid)
offering_components.billing_type string
Enum: fixed, usage, limit, one, few
offering_components.type string Unique internal name of the measured unit, for example floating_ip.
offering_components.name string Display name for the measured unit, for example, Floating IP.
offering_components.description string
offering_components.measured_unit string Unit of measurement, for example, GB.
offering_components.unit_factor integer The conversion factor from backend units to measured_unit
offering_components.limit_period any
offering_components.limit_amount integer
offering_components.article_code string
offering_components.max_value integer
offering_components.min_value integer
offering_components.max_available_limit integer
offering_components.is_boolean boolean
offering_components.default_limit integer
offering_components.factor integer
offering_components.is_builtin boolean
offering_components.is_prepaid boolean
offering_components.overage_component string (uuid)
offering_components.min_prepaid_duration integer
offering_components.max_prepaid_duration integer

Activate campaign

Activate campaign.

1
2
3
4
http \
  POST \
  https://api.example.com/api/promotions-campaigns/a1b2c3d4-e5f6-7890-abcd-ef1234567890/activate/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.promotions_campaigns import promotions_campaigns_activate # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = promotions_campaigns_activate.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: promotions_campaigns_activate
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { promotionsCampaignsActivate } from 'waldur-js-client';

try {
  const response = await promotionsCampaignsActivate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 - No response body

409 - No response body

Terminate campaign

Terminate campaign.

1
2
3
4
http \
  POST \
  https://api.example.com/api/promotions-campaigns/a1b2c3d4-e5f6-7890-abcd-ef1234567890/terminate/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.promotions_campaigns import promotions_campaigns_terminate # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = promotions_campaigns_terminate.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: promotions_campaigns_terminate
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { promotionsCampaignsTerminate } from 'waldur-js-client';

try {
  const response = await promotionsCampaignsTerminate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 - No response body

409 - No response body

Provider api

Marketplace Provider Offerings

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/marketplace-provider-offerings/ List provider offerings
GET /api/marketplace-provider-offerings/{uuid}/ Retrieve a provider offering
POST /api/marketplace-provider-offerings/ Create a provider offering
DELETE /api/marketplace-provider-offerings/{uuid}/ Delete a provider offering
State Management
POST /api/marketplace-provider-offerings/{uuid}/activate/ Activate an offering
POST /api/marketplace-provider-offerings/{uuid}/archive/ Archive an offering
POST /api/marketplace-provider-offerings/{uuid}/draft/ Move an offering to draft
POST /api/marketplace-provider-offerings/{uuid}/pause/ Pause an offering
POST /api/marketplace-provider-offerings/{uuid}/unpause/ Unpause an offering
Users and Accounts
GET /api/marketplace-provider-offerings/{uuid}/glauth_users_config/ Get GLauth user configuration
GET /api/marketplace-provider-offerings/{uuid}/list_course_accounts/ List course accounts for an offering
GET /api/marketplace-provider-offerings/{uuid}/list_customer_service_accounts/ List customer service accounts for an offering
GET /api/marketplace-provider-offerings/{uuid}/list_customer_users/ List customer users for an offering
GET /api/marketplace-provider-offerings/{uuid}/list_project_service_accounts/ List project service accounts for an offering
GET /api/marketplace-provider-offerings/{uuid}/list_users/ List users and their roles in a scope
GET /api/marketplace-provider-offerings/{uuid}/user_has_resource_access/ Check user access to offering resources
POST /api/marketplace-provider-offerings/{uuid}/add_user/ Grant a role to a user
POST /api/marketplace-provider-offerings/{uuid}/delete_user/ Revoke a role from a user
POST /api/marketplace-provider-offerings/{uuid}/refresh_offering_usernames/ Refresh offering user usernames
POST /api/marketplace-provider-offerings/{uuid}/update_user/ Update a user's role expiration
POST /api/marketplace-provider-offerings/{uuid}/update-user-attribute-config/ Update user attribute config
PUT /api/marketplace-provider-offerings/{uuid}/update-user-attribute-config/ Update user attribute config
PATCH /api/marketplace-provider-offerings/{uuid}/update-user-attribute-config/ Update user attribute config
DELETE /api/marketplace-provider-offerings/{uuid}/delete-user-attribute-config/ Delete user attribute config
Offering Components
POST /api/marketplace-provider-offerings/{uuid}/create_offering_component/ Create an offering component
POST /api/marketplace-provider-offerings/{uuid}/remove_offering_component/ Remove an offering component
POST /api/marketplace-provider-offerings/{uuid}/update_offering_component/ Update an offering component
Software Catalogs and Partitions
POST /api/marketplace-provider-offerings/{uuid}/add_partition/ Add a partition to an offering
POST /api/marketplace-provider-offerings/{uuid}/add_software_catalog/ Add a software catalog to an offering
POST /api/marketplace-provider-offerings/{uuid}/remove_partition/ Remove a partition from an offering
POST /api/marketplace-provider-offerings/{uuid}/remove_software_catalog/ Remove a software catalog from an offering
PATCH /api/marketplace-provider-offerings/{uuid}/update_partition/ Update a partition of an offering
PATCH /api/marketplace-provider-offerings/{uuid}/update_software_catalog/ Update software catalog configuration
Endpoints
POST /api/marketplace-provider-offerings/{uuid}/add_endpoint/ Add an access endpoint to an offering
POST /api/marketplace-provider-offerings/{uuid}/delete_endpoint/ Delete an access endpoint from an offering
Attachments and Images
POST /api/marketplace-provider-offerings/{uuid}/delete_image/ Delete offering image
POST /api/marketplace-provider-offerings/{uuid}/delete_thumbnail/ Delete offering thumbnail
POST /api/marketplace-provider-offerings/{uuid}/update_image/ Update offering image
POST /api/marketplace-provider-offerings/{uuid}/update_thumbnail/ Update offering thumbnail
Configuration & Updates
POST /api/marketplace-provider-offerings/{uuid}/delete_organization_groups/ Delete organization groups for offering
POST /api/marketplace-provider-offerings/{uuid}/move_offering/ Move an offering
POST /api/marketplace-provider-offerings/{uuid}/set_backend_metadata/ Set offering backend metadata
POST /api/marketplace-provider-offerings/{uuid}/update_attributes/ Update offering attributes
POST /api/marketplace-provider-offerings/{uuid}/update_compliance_checklist/ Update offering compliance checklist
POST /api/marketplace-provider-offerings/{uuid}/update_description/ Update offering category
POST /api/marketplace-provider-offerings/{uuid}/update_integration/ Update offering integration settings
POST /api/marketplace-provider-offerings/{uuid}/update_location/ Update offering location
POST /api/marketplace-provider-offerings/{uuid}/update_options/ Update offering options
POST /api/marketplace-provider-offerings/{uuid}/update_organization_groups/ Update organization groups for offering
POST /api/marketplace-provider-offerings/{uuid}/update_overview/ Update offering overview
POST /api/marketplace-provider-offerings/{uuid}/update_resource_options/ Update offering resource options
Data & Reporting
GET /api/marketplace-provider-offerings/{uuid}/component_stats/ Get statistics for offering components
GET /api/marketplace-provider-offerings/{uuid}/costs/ Get costs for an offering
GET /api/marketplace-provider-offerings/{uuid}/customers/ Get customers for an offering
GET /api/marketplace-provider-offerings/groups/ List offerings grouped by provider
GET /api/marketplace-provider-offerings/{uuid}/list_customer_projects/ List customer projects for an offering
GET /api/marketplace-provider-offerings/{uuid}/orders/ List orders for an offering
GET /api/marketplace-provider-offerings/{uuid}/orders/{order_uuid}/ Retrieve a specific order for an offering
GET /api/marketplace-provider-offerings/{uuid}/stats/ Get offering statistics
GET /api/marketplace-provider-offerings/{uuid}/tos_stats/ Get Terms of Service consent statistics
Remote Actions & Sync
GET /api/marketplace-provider-offerings/{uuid}/importable_resources/ List importable resources
POST /api/marketplace-provider-offerings/{uuid}/import_resource/ Import a resource
POST /api/marketplace-provider-offerings/{uuid}/sync/ Synchronize offering service settings
Other Actions
GET /api/marketplace-provider-offerings/{uuid}/history/at/ Get object state at a specific timestamp
GET /api/marketplace-provider-offerings/{uuid}/history/ Get version history
GET /api/marketplace-provider-offerings/{uuid}/user-attribute-config/ Get user attribute config
POST /api/marketplace-provider-offerings/{uuid}/check_unique_backend_id/ Check if backend_id is unique
POST /api/marketplace-provider-offerings/{uuid}/delete_tags/ Delete tags for offering
POST /api/marketplace-provider-offerings/{uuid}/export_offering/ Export offering data
POST /api/marketplace-provider-offerings/import_offering/ Import offering data
POST /api/marketplace-provider-offerings/{uuid}/make_available/ Mark an offering as available
POST /api/marketplace-provider-offerings/{uuid}/make_unavailable/ Mark an offering as unavailable
POST /api/marketplace-provider-offerings/{uuid}/update_backend_id_rules/ Update offering backend_id rules
POST /api/marketplace-provider-offerings/{uuid}/update_tags/ Update tags for offering

Core CRUD

List provider offerings

Returns a paginated list of offerings for the provider.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-provider-offerings/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.offering_state import OfferingState # (1)
from waldur_api_client.models.provider_offering_details_field_enum import ProviderOfferingDetailsFieldEnum # (2)
from waldur_api_client.models.provider_offering_details_o_enum import ProviderOfferingDetailsOEnum # (3)
from waldur_api_client.api.marketplace_provider_offerings import marketplace_provider_offerings_list # (4)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_provider_offerings_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: OfferingState
  2. Model Source: ProviderOfferingDetailsFieldEnum
  3. Model Source: ProviderOfferingDetailsOEnum
  4. API Source: marketplace_provider_offerings_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceProviderOfferingsList } from 'waldur-js-client';

try {
  const response = await marketplaceProviderOfferingsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
accessible_via_calls boolean Accessible via calls
allowed_customer_uuid string (uuid) Allowed customer UUID
attributes string Offering attributes (JSON)
billable boolean Billable
can_create_offering_user boolean
category_group_uuid string (uuid) Category group UUID
category_uuid string (uuid) Category UUID
created string (date-time) Created after
customer string (uri) Customer URL
customer_uuid string (uuid) Customer UUID
description string Description contains
field array
has_active_terms_of_service boolean Has Active Terms of Service
has_terms_of_service boolean Has Terms of Service
importable string Filter by importable offerings.
keyword string Keyword
modified string (date-time) Modified after
name string Name
name_exact string Name (exact)
o array Ordering
organization_group_uuid string (uuid) Organization group UUID
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
parent_uuid string (uuid) Parent offering UUID
project_uuid string (uuid) Project UUID
query string Search by offering name, slug or description
resource_customer_uuid string (uuid) Resource customer UUID
resource_project_uuid string (uuid) Resource project UUID
scope_uuid string Scope UUID
service_manager_uuid string (uuid) Service manager UUID
shared boolean Shared
state array Offering state
tag array Tag UUID (OR logic)
tag_name array Tag name (OR logic)
tag_names_and string Tag names with AND logic (comma-separated)
tags_and string Tag UUIDs with AND logic (comma-separated)
type array Offering type
user_has_consent boolean User Has Consent
user_has_offering_user boolean User Has Offering User
uuid_list string Comma-separated offering UUIDs

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
created string (date-time)
name string
slug string URL-friendly identifier. Only editable by staff users.
description string
full_description string
privacy_policy_link string (uri)
access_url string (uri) Publicly accessible offering access URL
endpoints array of objects
endpoints.uuid string (uuid)
endpoints.name string
endpoints.url string URL of the access endpoint
software_catalogs array of objects
software_catalogs.uuid string (uuid)
software_catalogs.catalog any
software_catalogs.enabled_cpu_family any List of enabled CPU families: ['x86_64', 'aarch64']
software_catalogs.enabled_cpu_microarchitectures any List of enabled CPU microarchitectures: ['generic', 'zen3']
software_catalogs.package_count integer
software_catalogs.partition any
partitions array of objects
partitions.uuid string (uuid)
partitions.partition_name string Name of the SLURM partition
partitions.cpu_bind integer Default task binding policy (SLURM cpu_bind)
partitions.def_cpu_per_gpu integer Default CPUs allocated per GPU
partitions.max_cpus_per_node integer Maximum allocated CPUs per node
partitions.max_cpus_per_socket integer Maximum allocated CPUs per socket
partitions.def_mem_per_cpu integer (int64) Default memory per CPU in MB
partitions.def_mem_per_gpu integer (int64) Default memory per GPU in MB
partitions.def_mem_per_node integer (int64) Default memory per node in MB
partitions.max_mem_per_cpu integer (int64) Maximum memory per CPU in MB
partitions.max_mem_per_node integer (int64) Maximum memory per node in MB
partitions.default_time integer Default time limit in minutes
partitions.max_time integer Maximum time limit in minutes
partitions.grace_time integer Preemption grace time in seconds
partitions.max_nodes integer Maximum nodes per job
partitions.min_nodes integer Minimum nodes per job
partitions.exclusive_topo boolean Exclusive topology access required
partitions.exclusive_user boolean Exclusive user access required
partitions.priority_tier integer Priority tier for scheduling and preemption
partitions.qos string Quality of Service (QOS) name
partitions.req_resv boolean Require reservation for job allocation
roles array of objects
roles.uuid string (uuid)
roles.name string
roles.url string (uri)
customer string (uri)
customer_uuid string (uuid)
customer_name string
project string (uri)
project_uuid string (uuid)
project_name string
category string (uri)
category_uuid string (uuid)
category_title string
attributes object (free-form)
options any
resource_options any
components array of objects
components.uuid string (uuid)
components.billing_type string
Enum: fixed, usage, limit, one, few
components.type string Unique internal name of the measured unit, for example floating_ip.
components.name string Display name for the measured unit, for example, Floating IP.
components.description string
components.measured_unit string Unit of measurement, for example, GB.
components.unit_factor integer The conversion factor from backend units to measured_unit
components.limit_period any
components.limit_amount integer
components.article_code string
components.max_value integer
components.min_value integer
components.max_available_limit integer
components.is_boolean boolean
components.default_limit integer
components.factor integer
components.is_builtin boolean
components.is_prepaid boolean
components.overage_component string (uuid)
components.min_prepaid_duration integer
components.max_prepaid_duration integer
plugin_options any
secret_options any
service_attributes object (free-form)
state any
vendor_details string
getting_started string
integration_guide string
thumbnail string (uri)
order_count integer
plans array of objects
plans.url string (uri)
plans.uuid string (uuid)
plans.name string
plans.description string
plans.article_code string
plans.max_amount integer Maximum number of plans that could be active. Plan is disabled when maximum amount is reached.
plans.archived boolean Forbids creation of new resources.
plans.is_active boolean
plans.unit_price string (decimal)
plans.unit string
Enum: month, quarter, half_month, day, hour, quantity
plans.init_price number (double)
plans.switch_price number (double)
plans.backend_id string
plans.organization_groups array of objects
plans.organization_groups.uuid string (uuid)
plans.organization_groups.url string (uri)
plans.organization_groups.name string
plans.organization_groups.parent_uuid string (uuid) UUID of the parent organization group
plans.organization_groups.parent_name string Name of the parent organization group
plans.organization_groups.parent string (uri)
plans.organization_groups.customers_count integer Number of customers in this organization group
plans.components array of objects
plans.components.type string Unique internal name of the measured unit, for example floating_ip.
plans.components.name string Display name for the measured unit, for example, Floating IP.
plans.components.measured_unit string Unit of measurement, for example, GB.
plans.components.amount integer
plans.components.price string (decimal)
plans.components.future_price string (decimal)
plans.components.discount_threshold integer Minimum amount to be eligible for discount.
plans.components.discount_rate integer Discount rate in percentage.
plans.prices object (free-form)
plans.future_prices object (free-form)
plans.quotas object (free-form)
plans.resources_count integer
plans.plan_type string
plans.minimal_price number (double)
screenshots array of objects
screenshots.name string
screenshots.uuid string (uuid)
screenshots.description string
screenshots.image string (uri)
screenshots.thumbnail string (uri)
screenshots.created string (date-time)
type string
shared boolean Accessible to all customers.
billable boolean Purchase and usage is invoiced.
scope string
scope_uuid string (uuid)
scope_name string (uuid)
scope_state any
scope_error_message string
files array of objects
files.name string
files.created string (date-time)
files.file string (uri)
quotas array of objects
quotas.name string
quotas.usage integer
quotas.limit integer
paused_reason string
datacite_doi string
citation_count integer Number of citations of a DOI
latitude number (double)
longitude number (double)
country any Country code (ISO 3166-1 alpha-2)
backend_id string
backend_id_rules any Validation rules for resource backend_id: format regex and uniqueness scope.
organization_groups array of objects
organization_groups.uuid string (uuid)
organization_groups.url string (uri)
organization_groups.name string
organization_groups.parent_uuid string (uuid) UUID of the parent organization group
organization_groups.parent_name string Name of the parent organization group
organization_groups.parent string (uri)
organization_groups.customers_count integer Number of customers in this organization group
tags array of objects
tags.uuid string (uuid)
tags.name string
image string (uri)
total_customers integer
total_cost integer
total_cost_estimated integer
parent_description string
parent_uuid string (uuid)
parent_name string
backend_metadata any
has_compliance_requirements boolean
billing_type_classification string Classify offering components by billing type. Returns 'limit_only', 'usage_only', or 'mixed'.
compliance_checklist string (uri)
integration_status array of objects
integration_status.agent_type any
integration_status.status string
integration_status.last_request_timestamp string (date-time)
integration_status.service_name string
google_calendar_is_public boolean
google_calendar_link string Get the Google Calendar link for an offering.

Retrieve a provider offering

Returns details of a specific provider offering.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-provider-offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.provider_offering_details_field_enum import ProviderOfferingDetailsFieldEnum # (1)
from waldur_api_client.api.marketplace_provider_offerings import marketplace_provider_offerings_retrieve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_provider_offerings_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. Model Source: ProviderOfferingDetailsFieldEnum
  2. API Source: marketplace_provider_offerings_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceProviderOfferingsRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceProviderOfferingsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type
field array

200 -

Field Type Description
url string (uri)
uuid string (uuid)
created string (date-time)
name string
slug string URL-friendly identifier. Only editable by staff users.
description string
full_description string
privacy_policy_link string (uri)
access_url string (uri) Publicly accessible offering access URL
endpoints array of objects
endpoints.uuid string (uuid)
endpoints.name string
endpoints.url string URL of the access endpoint
software_catalogs array of objects
software_catalogs.uuid string (uuid)
software_catalogs.catalog any
software_catalogs.enabled_cpu_family any List of enabled CPU families: ['x86_64', 'aarch64']
software_catalogs.enabled_cpu_microarchitectures any List of enabled CPU microarchitectures: ['generic', 'zen3']
software_catalogs.package_count integer
software_catalogs.partition any
partitions array of objects
partitions.uuid string (uuid)
partitions.partition_name string Name of the SLURM partition
partitions.cpu_bind integer Default task binding policy (SLURM cpu_bind)
partitions.def_cpu_per_gpu integer Default CPUs allocated per GPU
partitions.max_cpus_per_node integer Maximum allocated CPUs per node
partitions.max_cpus_per_socket integer Maximum allocated CPUs per socket
partitions.def_mem_per_cpu integer (int64) Default memory per CPU in MB
partitions.def_mem_per_gpu integer (int64) Default memory per GPU in MB
partitions.def_mem_per_node integer (int64) Default memory per node in MB
partitions.max_mem_per_cpu integer (int64) Maximum memory per CPU in MB
partitions.max_mem_per_node integer (int64) Maximum memory per node in MB
partitions.default_time integer Default time limit in minutes
partitions.max_time integer Maximum time limit in minutes
partitions.grace_time integer Preemption grace time in seconds
partitions.max_nodes integer Maximum nodes per job
partitions.min_nodes integer Minimum nodes per job
partitions.exclusive_topo boolean Exclusive topology access required
partitions.exclusive_user boolean Exclusive user access required
partitions.priority_tier integer Priority tier for scheduling and preemption
partitions.qos string Quality of Service (QOS) name
partitions.req_resv boolean Require reservation for job allocation
roles array of objects
roles.uuid string (uuid)
roles.name string
roles.url string (uri)
customer string (uri)
customer_uuid string (uuid)
customer_name string
project string (uri)
project_uuid string (uuid)
project_name string
category string (uri)
category_uuid string (uuid)
category_title string
attributes object (free-form)
options any
resource_options any
components array of objects
components.uuid string (uuid)
components.billing_type string
Enum: fixed, usage, limit, one, few
components.type string Unique internal name of the measured unit, for example floating_ip.
components.name string Display name for the measured unit, for example, Floating IP.
components.description string
components.measured_unit string Unit of measurement, for example, GB.
components.unit_factor integer The conversion factor from backend units to measured_unit
components.limit_period any
components.limit_amount integer
components.article_code string
components.max_value integer
components.min_value integer
components.max_available_limit integer
components.is_boolean boolean
components.default_limit integer
components.factor integer
components.is_builtin boolean
components.is_prepaid boolean
components.overage_component string (uuid)
components.min_prepaid_duration integer
components.max_prepaid_duration integer
plugin_options any
secret_options any
service_attributes object (free-form)
state any
vendor_details string
getting_started string
integration_guide string
thumbnail string (uri)
order_count integer
plans array of objects
plans.url string (uri)
plans.uuid string (uuid)
plans.name string
plans.description string
plans.article_code string
plans.max_amount integer Maximum number of plans that could be active. Plan is disabled when maximum amount is reached.
plans.archived boolean Forbids creation of new resources.
plans.is_active boolean
plans.unit_price string (decimal)
plans.unit string
Enum: month, quarter, half_month, day, hour, quantity
plans.init_price number (double)
plans.switch_price number (double)
plans.backend_id string
plans.organization_groups array of objects
plans.organization_groups.uuid string (uuid)
plans.organization_groups.url string (uri)
plans.organization_groups.name string
plans.organization_groups.parent_uuid string (uuid) UUID of the parent organization group
plans.organization_groups.parent_name string Name of the parent organization group
plans.organization_groups.parent string (uri)
plans.organization_groups.customers_count integer Number of customers in this organization group
plans.components array of objects
plans.components.type string Unique internal name of the measured unit, for example floating_ip.
plans.components.name string Display name for the measured unit, for example, Floating IP.
plans.components.measured_unit string Unit of measurement, for example, GB.
plans.components.amount integer
plans.components.price string (decimal)
plans.components.future_price string (decimal)
plans.components.discount_threshold integer Minimum amount to be eligible for discount.
plans.components.discount_rate integer Discount rate in percentage.
plans.prices object (free-form)
plans.future_prices object (free-form)
plans.quotas object (free-form)
plans.resources_count integer
plans.plan_type string
plans.minimal_price number (double)
screenshots array of objects
screenshots.name string
screenshots.uuid string (uuid)
screenshots.description string
screenshots.image string (uri)
screenshots.thumbnail string (uri)
screenshots.created string (date-time)
type string
shared boolean Accessible to all customers.
billable boolean Purchase and usage is invoiced.
scope string
scope_uuid string (uuid)
scope_name string (uuid)
scope_state any
scope_error_message string
files array of objects
files.name string
files.created string (date-time)
files.file string (uri)
quotas array of objects
quotas.name string
quotas.usage integer
quotas.limit integer
paused_reason string
datacite_doi string
citation_count integer Number of citations of a DOI
latitude number (double)
longitude number (double)
country any Country code (ISO 3166-1 alpha-2)
backend_id string
backend_id_rules any Validation rules for resource backend_id: format regex and uniqueness scope.
organization_groups array of objects
organization_groups.uuid string (uuid)
organization_groups.url string (uri)
organization_groups.name string
organization_groups.parent_uuid string (uuid) UUID of the parent organization group
organization_groups.parent_name string Name of the parent organization group
organization_groups.parent string (uri)
organization_groups.customers_count integer Number of customers in this organization group
tags array of objects
tags.uuid string (uuid)
tags.name string
image string (uri)
total_customers integer
total_cost integer
total_cost_estimated integer
parent_description string
parent_uuid string (uuid)
parent_name string
backend_metadata any
has_compliance_requirements boolean
billing_type_classification string Classify offering components by billing type. Returns 'limit_only', 'usage_only', or 'mixed'.
compliance_checklist string (uri)
integration_status array of objects
integration_status.agent_type any
integration_status.status string
integration_status.last_request_timestamp string (date-time)
integration_status.service_name string
google_calendar_is_public boolean
google_calendar_link string Get the Google Calendar link for an offering.

Create a provider offering

Creates a new provider offering.

1
2
3
4
5
6
7
http \
  POST \
  https://api.example.com/api/marketplace-provider-offerings/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-marketplace-provider-offering" \
  category="https://api.example.com/api/category/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  type="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.offering_create_request import OfferingCreateRequest # (1)
from waldur_api_client.api.marketplace_provider_offerings import marketplace_provider_offerings_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OfferingCreateRequest(
    name="my-awesome-marketplace-provider-offering",
    category="https://api.example.com/api/category/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    type="string-value"
)
response = marketplace_provider_offerings_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OfferingCreateRequest
  2. API Source: marketplace_provider_offerings_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
import { marketplaceProviderOfferingsCreate } from 'waldur-js-client';

try {
  const response = await marketplaceProviderOfferingsCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "name": "my-awesome-marketplace-provider-offering",
    "category": "https://api.example.com/api/category/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "type": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
name string ✓
slug string URL-friendly identifier. Only editable by staff users.
description string
full_description string
privacy_policy_link string (uri)
access_url string (uri) Publicly accessible offering access URL
customer string (uri)
category string (uri) ✓
attributes any
options object
options.order array of strings ✓
options.options object (free-form) ✓
resource_options object
resource_options.order array of strings ✓
resource_options.options object (free-form) ✓
components array of objects
components.billing_type string ✓
Enum: fixed, usage, limit, one, few
components.type string ✓ Unique internal name of the measured unit, for example floating_ip.
components.name string ✓ Display name for the measured unit, for example, Floating IP.
components.description string
components.measured_unit string Unit of measurement, for example, GB.
components.unit_factor integer The conversion factor from backend units to measured_unit
components.limit_period any
components.limit_amount integer
components.article_code string
components.max_value integer
components.min_value integer
components.max_available_limit integer
components.is_boolean boolean
components.default_limit integer
components.is_prepaid boolean
components.overage_component string (uuid)
components.min_prepaid_duration integer
components.max_prepaid_duration integer
plugin_options object
plugin_options.auto_approve_remote_orders boolean If set to True, an order can be processed without approval
plugin_options.resource_expiration_threshold integer Resource expiration threshold in days.
Constraints: default: 30
plugin_options.service_provider_can_create_offering_user boolean Service provider can create offering user
plugin_options.max_resource_termination_offset_in_days integer Maximum resource termination offset in days
plugin_options.default_resource_termination_offset_in_days integer If set, it will be used as a default resource termination offset in days
plugin_options.is_resource_termination_date_required boolean If set to True, resource termination date is required
plugin_options.latest_date_for_resource_termination string If set, it will be used as a latest date for resource termination. Format: YYYY-MM-DD
plugin_options.auto_approve_in_service_provider_projects boolean Skip approval of public offering belonging to the same organization under which the request is done
plugin_options.disable_autoapprove boolean If set to True, orders for this offering will always require manual approval, overriding auto_approve_in_service_provider_projects
plugin_options.supports_downscaling boolean If set to True, it will be possible to downscale resources
plugin_options.supports_pausing boolean If set to True, it will be possible to pause resources
plugin_options.minimal_team_count_for_provisioning integer Minimal team count required for provisioning of resources
plugin_options.maximal_resource_count_per_project integer Maximal number of offering resources allowed per project
plugin_options.unique_resource_per_attribute string Attribute name to enforce uniqueness per value. E.g., 'storage_data_type' ensures only one resource per storage type per project.
plugin_options.required_team_role_for_provisioning string Required user role in a project for provisioning of resources
plugin_options.enable_purchase_order_upload boolean If set to True, users will be able to upload purchase orders.
plugin_options.require_purchase_order_upload boolean If set to True, users will be required to upload purchase orders.
plugin_options.conceal_billing_data boolean If set to True, pricing and components tab would be concealed.
plugin_options.create_orders_on_resource_option_change boolean If set to True, create orders when options of related resources are changed.
plugin_options.can_restore_resource boolean If set to True, resource can be restored.
plugin_options.enable_provider_consumer_messaging boolean If set to True, service providers can send messages with attachments to consumers on pending orders, and consumers can respond.
plugin_options.notify_about_provider_consumer_messages boolean If set to True, send email notifications when providers or consumers exchange messages on pending orders.
plugin_options.restrict_deletion_with_active_resources boolean If set to True, offering cannot be deleted while it has non-terminated resources.
plugin_options.resource_name_pattern string Python format string for generating resource names. Available variables: {customer_name}, {customer_slug}, {project_name}, {project_slug}, {offering_name}, {offering_slug}, {plan_name}, {counter}, {attributes[KEY]}.
plugin_options.default_internal_network_mtu integer If set, it will be used as a default MTU for the first network in a tenant
plugin_options.max_instances integer Default limit for number of instances in OpenStack tenant
plugin_options.max_volumes integer Default limit for number of volumes in OpenStack tenant
plugin_options.max_security_groups integer Default limit for number of security groups in OpenStack tenant
plugin_options.storage_mode any Storage mode for OpenStack offering
plugin_options.snapshot_size_limit_gb integer Default limit for snapshot size in GB
plugin_options.heappe_cluster_id string HEAppE cluster id
plugin_options.heappe_local_base_path string HEAppE local base path
plugin_options.heappe_url string HEAppE url
plugin_options.heappe_username string HEAppE username
plugin_options.homedir_prefix string GLAuth homedir prefix
Constraints: default: /home/
plugin_options.scratch_project_directory string HEAppE scratch project directory
plugin_options.project_permanent_directory string HEAppE project permanent directory
plugin_options.initial_primarygroup_number integer GLAuth initial primary group number
Constraints: default: 5000
plugin_options.initial_uidnumber integer GLAuth initial uidnumber
Constraints: default: 5000
plugin_options.initial_usergroup_number integer GLAuth initial usergroup number
Constraints: default: 6000
plugin_options.username_anonymized_prefix string GLAuth prefix for anonymized usernames
Constraints: default: waldur_
plugin_options.username_generation_policy any GLAuth username generation policy
Constraints: default: service_provider
plugin_options.enable_issues_for_membership_changes boolean Enable issues for membership changes
plugin_options.deployment_mode any Rancher deployment mode
plugin_options.flavors_regex string Regular expression to limit flavors list
plugin_options.openstack_offering_uuid_list array of strings List of UUID of OpenStack offerings where tenant can be created
plugin_options.managed_rancher_server_flavor_name string Flavor name for managed Rancher server instances
plugin_options.managed_rancher_server_system_volume_size_gb integer System volume size in GB for managed Rancher server
plugin_options.managed_rancher_server_system_volume_type_name string System volume type name for managed Rancher server
plugin_options.managed_rancher_server_data_volume_size_gb integer Data volume size in GB for managed Rancher server
plugin_options.managed_rancher_server_data_volume_type_name string Data volume type name for managed Rancher server
plugin_options.managed_rancher_worker_system_volume_size_gb integer System volume size in GB for managed Rancher worker nodes
plugin_options.managed_rancher_worker_system_volume_type_name string System volume type name for managed Rancher worker nodes
plugin_options.managed_rancher_load_balancer_flavor_name string Flavor name for managed Rancher load balancer
plugin_options.managed_rancher_load_balancer_system_volume_size_gb integer System volume size in GB for managed Rancher load balancer
plugin_options.managed_rancher_load_balancer_system_volume_type_name string System volume type name for managed Rancher load balancer
plugin_options.managed_rancher_load_balancer_data_volume_size_gb integer Data volume size in GB for managed Rancher load balancer
plugin_options.managed_rancher_load_balancer_data_volume_type_name string Data volume type name for managed Rancher load balancer
plugin_options.managed_rancher_tenant_max_cpu integer Max number of vCPUs for tenants
plugin_options.managed_rancher_tenant_max_ram integer Max number of RAM for tenants (GB)
plugin_options.managed_rancher_tenant_max_disk integer Max size of disk space for tenants (GB)
plugin_options.account_name_generation_policy any Slurm account name generation policy
plugin_options.enable_display_of_order_actions_for_service_provider boolean Enable display of order actions for service provider
Constraints: default: True
plugin_options.slurm_periodic_policy_enabled boolean Enable SLURM periodic usage policy configuration. When enabled, allows configuring QoS-based threshold enforcement, carryover logic, and fairshare decay for site-agent managed SLURM offerings.
Constraints: default: False
plugin_options.auto_approve_marketplace_script boolean If set to False, all orders require manual provider approval, including for service provider owners and staff
Constraints: default: True
plugin_options.keycloak_enabled boolean If set to True, Keycloak group management is enabled for this offering.
plugin_options.keycloak_base_group string Root parent group in Keycloak under which offering groups are created. Groups are organized as: {base_group}/{offering_slug}/{role_group}. If empty, offering groups are created at the realm root.
plugin_options.keycloak_sync_frequency integer Frequency in minutes for syncing Keycloak group memberships.
plugin_options.keycloak_group_name_template string Template for generating Keycloak group names. Uses $variable syntax (e.g. $offering_uuid_$role_name). Allowed variables: offering_uuid, offering_name, offering_slug, resource_uuid, resource_name, resource_slug, project_uuid, project_name, project_slug, organization_uuid, organization_name, organization_slug, role_name, scope_id.
plugin_options.keycloak_username_label string Custom label for the username field when inviting external users (e.g. 'Civil code', 'CUID'). If empty, defaults to 'Username'.
Constraints: default: ``
plugin_options.highlight_backend_id_display boolean Defines if backend_id should be shown more prominently by the UI
Constraints: default: False
plugin_options.backend_id_display_label string Label used by UI for showing value of the backend_id
Constraints: default: Backend ID
plugin_options.disabled_resource_actions array of strings List of disabled marketplace resource actions for this offering.
vendor_details string
getting_started string
integration_guide string
thumbnail string (binary)
plans array of objects
plans.name string ✓
plans.description string
plans.article_code string
plans.max_amount integer Maximum number of plans that could be active. Plan is disabled when maximum amount is reached.
plans.archived boolean Forbids creation of new resources.
plans.unit_price string (decimal)
plans.unit string
Enum: month, quarter, half_month, day, hour, quantity
plans.backend_id string
type string ✓
shared boolean Accessible to all customers.
billable boolean Purchase and usage is invoiced.
datacite_doi string
latitude number (double)
longitude number (double)
country any Country code (ISO 3166-1 alpha-2)
backend_id string
backend_id_rules any Validation rules for resource backend_id: format regex and uniqueness scope.
image string (binary)
backend_metadata any
compliance_checklist string (uri)
limits object (free-form)
Constraints: write-only

201 -

Field Type Description
url string (uri)
uuid string (uuid)
created string (date-time)
name string
slug string URL-friendly identifier. Only editable by staff users.
description string
full_description string
privacy_policy_link string (uri)
access_url string (uri) Publicly accessible offering access URL
endpoints array of objects
endpoints.uuid string (uuid)
endpoints.name string
endpoints.url string URL of the access endpoint
software_catalogs array of objects
software_catalogs.uuid string (uuid)
software_catalogs.catalog any
software_catalogs.enabled_cpu_family any List of enabled CPU families: ['x86_64', 'aarch64']
software_catalogs.enabled_cpu_microarchitectures any List of enabled CPU microarchitectures: ['generic', 'zen3']
software_catalogs.package_count integer
software_catalogs.partition any
partitions array of objects
partitions.uuid string (uuid)
partitions.partition_name string Name of the SLURM partition
partitions.cpu_bind integer Default task binding policy (SLURM cpu_bind)
partitions.def_cpu_per_gpu integer Default CPUs allocated per GPU
partitions.max_cpus_per_node integer Maximum allocated CPUs per node
partitions.max_cpus_per_socket integer Maximum allocated CPUs per socket
partitions.def_mem_per_cpu integer (int64) Default memory per CPU in MB
partitions.def_mem_per_gpu integer (int64) Default memory per GPU in MB
partitions.def_mem_per_node integer (int64) Default memory per node in MB
partitions.max_mem_per_cpu integer (int64) Maximum memory per CPU in MB
partitions.max_mem_per_node integer (int64) Maximum memory per node in MB
partitions.default_time integer Default time limit in minutes
partitions.max_time integer Maximum time limit in minutes
partitions.grace_time integer Preemption grace time in seconds
partitions.max_nodes integer Maximum nodes per job
partitions.min_nodes integer Minimum nodes per job
partitions.exclusive_topo boolean Exclusive topology access required
partitions.exclusive_user boolean Exclusive user access required
partitions.priority_tier integer Priority tier for scheduling and preemption
partitions.qos string Quality of Service (QOS) name
partitions.req_resv boolean Require reservation for job allocation
roles array of objects
roles.uuid string (uuid)
roles.name string
roles.url string (uri)
customer string (uri)
customer_uuid string (uuid)
customer_name string
project string (uri)
project_uuid string (uuid)
project_name string
category string (uri)
category_uuid string (uuid)
category_title string
attributes object (free-form)
options any
resource_options any
components array of objects
components.uuid string (uuid)
components.billing_type string
Enum: fixed, usage, limit, one, few
components.type string Unique internal name of the measured unit, for example floating_ip.
components.name string Display name for the measured unit, for example, Floating IP.
components.description string
components.measured_unit string Unit of measurement, for example, GB.
components.unit_factor integer The conversion factor from backend units to measured_unit
components.limit_period any
components.limit_amount integer
components.article_code string
components.max_value integer
components.min_value integer
components.max_available_limit integer
components.is_boolean boolean
components.default_limit integer
components.factor integer
components.is_builtin boolean
components.is_prepaid boolean
components.overage_component string (uuid)
components.min_prepaid_duration integer
components.max_prepaid_duration integer
plugin_options any
secret_options any
service_attributes object (free-form)
state any
vendor_details string
getting_started string
integration_guide string
thumbnail string (uri)
order_count integer
plans array of objects
plans.url string (uri)
plans.uuid string (uuid)
plans.name string
plans.description string
plans.article_code string
plans.max_amount integer Maximum number of plans that could be active. Plan is disabled when maximum amount is reached.
plans.archived boolean Forbids creation of new resources.
plans.is_active boolean
plans.unit_price string (decimal)
plans.unit string
Enum: month, quarter, half_month, day, hour, quantity
plans.init_price number (double)
plans.switch_price number (double)
plans.backend_id string
plans.organization_groups array of objects
plans.organization_groups.uuid string (uuid)
plans.organization_groups.url string (uri)
plans.organization_groups.name string
plans.organization_groups.parent_uuid string (uuid) UUID of the parent organization group
plans.organization_groups.parent_name string Name of the parent organization group
plans.organization_groups.parent string (uri)
plans.organization_groups.customers_count integer Number of customers in this organization group
plans.components array of objects
plans.components.type string Unique internal name of the measured unit, for example floating_ip.
plans.components.name string Display name for the measured unit, for example, Floating IP.
plans.components.measured_unit string Unit of measurement, for example, GB.
plans.components.amount integer
plans.components.price string (decimal)
plans.components.future_price string (decimal)
plans.components.discount_threshold integer Minimum amount to be eligible for discount.
plans.components.discount_rate integer Discount rate in percentage.
plans.prices object (free-form)
plans.future_prices object (free-form)
plans.quotas object (free-form)
plans.resources_count integer
plans.plan_type string
plans.minimal_price number (double)
screenshots array of objects
screenshots.name string
screenshots.uuid string (uuid)
screenshots.description string
screenshots.image string (uri)
screenshots.thumbnail string (uri)
screenshots.created string (date-time)
type string
shared boolean Accessible to all customers.
billable boolean Purchase and usage is invoiced.
scope string
scope_uuid string (uuid)
scope_name string (uuid)
scope_state any
scope_error_message string
files array of objects
files.name string
files.created string (date-time)
files.file string (uri)
quotas array of objects
quotas.name string
quotas.usage integer
quotas.limit integer
paused_reason string
datacite_doi string
citation_count integer Number of citations of a DOI
latitude number (double)
longitude number (double)
country any Country code (ISO 3166-1 alpha-2)
backend_id string
backend_id_rules any Validation rules for resource backend_id: format regex and uniqueness scope.
organization_groups array of objects
organization_groups.uuid string (uuid)
organization_groups.url string (uri)
organization_groups.name string
organization_groups.parent_uuid string (uuid) UUID of the parent organization group
organization_groups.parent_name string Name of the parent organization group
organization_groups.parent string (uri)
organization_groups.customers_count integer Number of customers in this organization group
tags array of objects
tags.uuid string (uuid)
tags.name string
image string (uri)
total_customers integer
total_cost integer
total_cost_estimated integer
parent_description string
parent_uuid string (uuid)
parent_name string
backend_metadata any
has_compliance_requirements boolean
billing_type_classification string Classify offering components by billing type. Returns 'limit_only', 'usage_only', or 'mixed'.
compliance_checklist string (uri)
integration_status array of objects
integration_status.agent_type any
integration_status.status string
integration_status.last_request_timestamp string (date-time)
integration_status.service_name string
google_calendar_is_public boolean
google_calendar_link string Get the Google Calendar link for an offering.

Delete a provider offering

Deletes a provider offering. Only possible for offerings in a Draft state with no associated resources.

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/marketplace-provider-offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_provider_offerings import marketplace_provider_offerings_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_provider_offerings_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_provider_offerings_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceProviderOfferingsDestroy } from 'waldur-js-client';

try {
  const response = await marketplaceProviderOfferingsDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

State Management

Activate an offering

Activates a draft or paused offering, making it available for ordering.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-provider-offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/activate/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_provider_offerings import marketplace_provider_offerings_activate # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_provider_offerings_activate.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_provider_offerings_activate
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceProviderOfferingsActivate } from 'waldur-js-client';

try {
  const response = await marketplaceProviderOfferingsActivate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
detail string
state string

Archive an offering

Archives an offering, making it permanently unavailable for new orders.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-provider-offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/archive/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_provider_offerings import marketplace_provider_offerings_archive # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_provider_offerings_archive.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_provider_offerings_archive
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceProviderOfferingsArchive } from 'waldur-js-client';

try {
  const response = await marketplaceProviderOfferingsArchive({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
detail string
state string

Move an offering to draft

Moves an active or paused offering back to the draft state for editing.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-provider-offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/draft/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_provider_offerings import marketplace_provider_offerings_draft # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_provider_offerings_draft.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_provider_offerings_draft
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceProviderOfferingsDraft } from 'waldur-js-client';

try {
  const response = await marketplaceProviderOfferingsDraft({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
detail string
state string

Pause an offering

Pauses an active offering, preventing new orders from being created.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-provider-offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/pause/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.offering_pause_request import OfferingPauseRequest # (1)
from waldur_api_client.api.marketplace_provider_offerings import marketplace_provider_offerings_pause # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OfferingPauseRequest()
response = marketplace_provider_offerings_pause.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OfferingPauseRequest
  2. API Source: marketplace_provider_offerings_pause
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceProviderOfferingsPause } from 'waldur-js-client';

try {
  const response = await marketplaceProviderOfferingsPause({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
paused_reason string

200 -

Field Type
detail string
state string

Unpause an offering

Resumes a paused offering, making it available for ordering again.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-provider-offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/unpause/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_provider_offerings import marketplace_provider_offerings_unpause # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_provider_offerings_unpause.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_provider_offerings_unpause
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceProviderOfferingsUnpause } from 'waldur-js-client';

try {
  const response = await marketplaceProviderOfferingsUnpause({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
detail string
state string

Users and Accounts

Get GLauth user configuration

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
    This endpoint provides a configuration file for GLauth.
    It is intended to be used by an external agent to synchronize user data from Waldur to GLauth.

    Example output format:
    ```
    [[users]]
      name = "johndoe"
      givenname="John"
      sn="Doe"
      mail = "john.doe@example.com"
      ...
    [[groups]]
      name = "group1"
      gidnumber = 1001
    ```

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-provider-offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/glauth_users_config/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_provider_offerings import marketplace_provider_offerings_glauth_users_config_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_provider_offerings_glauth_users_config_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_provider_offerings_glauth_users_config_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceProviderOfferingsGlauthUsersConfigRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceProviderOfferingsGlauthUsersConfigRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

List course accounts for an offering

Returns a paginated list of course accounts for projects that have resources of this offering.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-provider-offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/list_course_accounts/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.offering_state import OfferingState # (1)
from waldur_api_client.models.provider_offering_details_o_enum import ProviderOfferingDetailsOEnum # (2)
from waldur_api_client.api.marketplace_provider_offerings import marketplace_provider_offerings_list_course_accounts_list # (3)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_provider_offerings_list_course_accounts_list.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

for item in response:
    print(item)
  1. Model Source: OfferingState
  2. Model Source: ProviderOfferingDetailsOEnum
  3. API Source: marketplace_provider_offerings_list_course_accounts_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceProviderOfferingsListCourseAccountsList } from 'waldur-js-client';

try {
  const response = await marketplaceProviderOfferingsListCourseAccountsList({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type Description
accessible_via_calls boolean Accessible via calls
allowed_customer_uuid string (uuid) Allowed customer UUID
attributes string Offering attributes (JSON)
billable boolean Billable
can_create_offering_user boolean
category_group_uuid string (uuid) Category group UUID
category_uuid string (uuid) Category UUID
created string (date-time) Created after
customer string (uri) Customer URL
customer_uuid string (uuid) Customer UUID
description string Description contains
has_active_terms_of_service boolean Has Active Terms of Service
has_terms_of_service boolean Has Terms of Service
importable string Filter by importable offerings.
keyword string Keyword
modified string (date-time) Modified after
name string Name
name_exact string Name (exact)
o array Ordering
organization_group_uuid string (uuid) Organization group UUID
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
parent_uuid string (uuid) Parent offering UUID
project_uuid string (uuid) Project UUID
query string Search by offering name, slug or description
resource_customer_uuid string (uuid) Resource customer UUID
resource_project_uuid string (uuid) Resource project UUID
scope_uuid string Scope UUID
service_manager_uuid string (uuid) Service manager UUID
shared boolean Shared
state array Offering state
tag array Tag UUID (OR logic)
tag_name array Tag name (OR logic)
tag_names_and string Tag names with AND logic (comma-separated)
tags_and string Tag UUIDs with AND logic (comma-separated)
type array Offering type
user_has_consent boolean User Has Consent
user_has_offering_user boolean User Has Offering User
uuid_list string Comma-separated offering UUIDs

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
url string (uri)
uuid string (uuid)
created string (date-time)
modified string (date-time)
project string (uuid)
project_uuid string (uuid)
project_name string
project_slug string
project_start_date string (date)
project_end_date string (date)
user_uuid string (uuid)
username string
customer_uuid string (uuid)
customer_name string
state any
email string (email)
description string
error_message string
error_traceback string

List customer service accounts for an offering

Returns a paginated list of customer-level service accounts for customers who have resources of this offering.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-provider-offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/list_customer_service_accounts/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.offering_state import OfferingState # (1)
from waldur_api_client.models.provider_offering_details_o_enum import ProviderOfferingDetailsOEnum # (2)
from waldur_api_client.api.marketplace_provider_offerings import marketplace_provider_offerings_list_customer_service_accounts_list # (3)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_provider_offerings_list_customer_service_accounts_list.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

for item in response:
    print(item)
  1. Model Source: OfferingState
  2. Model Source: ProviderOfferingDetailsOEnum
  3. API Source: marketplace_provider_offerings_list_customer_service_accounts_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceProviderOfferingsListCustomerServiceAccountsList } from 'waldur-js-client';

try {
  const response = await marketplaceProviderOfferingsListCustomerServiceAccountsList({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type Description
accessible_via_calls boolean Accessible via calls
allowed_customer_uuid string (uuid) Allowed customer UUID
attributes string Offering attributes (JSON)
billable boolean Billable
can_create_offering_user boolean
category_group_uuid string (uuid) Category group UUID
category_uuid string (uuid) Category UUID
created string (date-time) Created after
customer string (uri) Customer URL
customer_uuid string (uuid) Customer UUID
description string Description contains
has_active_terms_of_service boolean Has Active Terms of Service
has_terms_of_service boolean Has Terms of Service
importable string Filter by importable offerings.
keyword string Keyword
modified string (date-time) Modified after
name string Name
name_exact string Name (exact)
o array Ordering
organization_group_uuid string (uuid) Organization group UUID
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
parent_uuid string (uuid) Parent offering UUID
project_uuid string (uuid) Project UUID
query string Search by offering name, slug or description
resource_customer_uuid string (uuid) Resource customer UUID
resource_project_uuid string (uuid) Resource project UUID
scope_uuid string Scope UUID
service_manager_uuid string (uuid) Service manager UUID
shared boolean Shared
state array Offering state
tag array Tag UUID (OR logic)
tag_name array Tag name (OR logic)
tag_names_and string Tag names with AND logic (comma-separated)
tags_and string Tag UUIDs with AND logic (comma-separated)
type array Offering type
user_has_consent boolean User Has Consent
user_has_offering_user boolean User Has Offering User
uuid_list string Comma-separated offering UUIDs

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
url string (uri)
uuid string (uuid)
created string (date-time)
modified string (date-time)
username string
description string
error_message string
error_traceback string
state any
token string
email string (email)
expires_at string
preferred_identifier string
customer string (uuid)
customer_uuid string (uuid)
customer_name string

List customer users for an offering

Returns a paginated list of users who have access to resources of this offering.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-provider-offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/list_customer_users/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.user_field_enum import UserFieldEnum # (1)
from waldur_api_client.api.marketplace_provider_offerings import marketplace_provider_offerings_list_customer_users_list # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_provider_offerings_list_customer_users_list.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

for item in response:
    print(item)
  1. Model Source: UserFieldEnum
  2. API Source: marketplace_provider_offerings_list_customer_users_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceProviderOfferingsListCustomerUsersList } from 'waldur-js-client';

try {
  const response = await marketplaceProviderOfferingsListCustomerUsersList({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type Description
field array
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
slug string URL-friendly identifier. Only editable by staff users.
full_name string
native_name string
job_title string
email string (email)
phone_number string
organization string
civil_number string
description string
is_staff boolean Designates whether the user can log into this admin site.
is_active boolean Designates whether this user should be treated as active. Unselect this instead of deleting accounts.
is_support boolean Designates whether the user is a global support user.
token string
token_lifetime integer Token lifetime in seconds.
token_expires_at string (date-time)
registration_method string Indicates what registration method was used.
date_joined string (date-time)
agreement_date string (date-time) Indicates when the user has agreed with the policy.
notifications_enabled boolean Designates whether the user is allowed to receive email notifications.
preferred_language string
permissions array of objects
permissions.user_uuid string (uuid)
permissions.user_name string
permissions.user_slug string
permissions.created string (date-time)
permissions.expiration_time string (date-time)
permissions.created_by_full_name string
permissions.created_by_username string
permissions.role_name string
permissions.role_description string
permissions.role_uuid string (uuid)
permissions.scope_type string
permissions.scope_uuid string (uuid)
permissions.scope_name string
permissions.customer_uuid string (uuid)
permissions.customer_name string
requested_email string
affiliations any Person's affiliation within organization such as student, faculty, staff.
first_name string
last_name string
birth_date string (date)
identity_provider_name string
identity_provider_label string
identity_provider_management_url string
identity_provider_fields array of strings
image string (uri)
identity_source string Indicates what identity provider was used.
has_active_session boolean
ip_address string
gender any ISO 5218 gender code
personal_title string Honorific title (Mr, Ms, Dr, Prof, etc.)
place_of_birth string
country_of_residence string
nationality string Primary citizenship (ISO 3166-1 alpha-2 code)
nationalities any List of all citizenships (ISO 3166-1 alpha-2 codes)
organization_country string
organization_type string SCHAC URN (e.g., urn:schac:homeOrganizationType:int:university)
organization_registry_code string Company registration code of the user's organization, if known
eduperson_assurance any REFEDS assurance profile URIs from identity provider
is_identity_manager boolean Designates whether the user is allowed to manage remote user identities.
attribute_sources any Per-attribute source and freshness tracking. Format: {'field_name': {'source': 'isd:', 'timestamp': 'ISO8601'}}.
managed_isds any List of ISD source identifiers this user can manage via Identity Bridge. E.g., ['isd:puhuri', 'isd:fenix']. Non-empty list implies identity manager role.
active_isds any List of ISDs that have asserted this user exists. User is deactivated when this becomes empty.

List project service accounts for an offering

Returns a paginated list of project-level service accounts for projects that have resources of this offering.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-provider-offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/list_project_service_accounts/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.offering_state import OfferingState # (1)
from waldur_api_client.models.provider_offering_details_o_enum import ProviderOfferingDetailsOEnum # (2)
from waldur_api_client.api.marketplace_provider_offerings import marketplace_provider_offerings_list_project_service_accounts_list # (3)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_provider_offerings_list_project_service_accounts_list.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

for item in response:
    print(item)
  1. Model Source: OfferingState
  2. Model Source: ProviderOfferingDetailsOEnum
  3. API Source: marketplace_provider_offerings_list_project_service_accounts_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceProviderOfferingsListProjectServiceAccountsList } from 'waldur-js-client';

try {
  const response = await marketplaceProviderOfferingsListProjectServiceAccountsList({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type Description
accessible_via_calls boolean Accessible via calls
allowed_customer_uuid string (uuid) Allowed customer UUID
attributes string Offering attributes (JSON)
billable boolean Billable
can_create_offering_user boolean
category_group_uuid string (uuid) Category group UUID
category_uuid string (uuid) Category UUID
created string (date-time) Created after
customer string (uri) Customer URL
customer_uuid string (uuid) Customer UUID
description string Description contains
has_active_terms_of_service boolean Has Active Terms of Service
has_terms_of_service boolean Has Terms of Service
importable string Filter by importable offerings.
keyword string Keyword
modified string (date-time) Modified after
name string Name
name_exact string Name (exact)
o array Ordering
organization_group_uuid string (uuid) Organization group UUID
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
parent_uuid string (uuid) Parent offering UUID
project_uuid string (uuid) Project UUID
query string Search by offering name, slug or description
resource_customer_uuid string (uuid) Resource customer UUID
resource_project_uuid string (uuid) Resource project UUID
scope_uuid string Scope UUID
service_manager_uuid string (uuid) Service manager UUID
shared boolean Shared
state array Offering state
tag array Tag UUID (OR logic)
tag_name array Tag name (OR logic)
tag_names_and string Tag names with AND logic (comma-separated)
tags_and string Tag UUIDs with AND logic (comma-separated)
type array Offering type
user_has_consent boolean User Has Consent
user_has_offering_user boolean User Has Offering User
uuid_list string Comma-separated offering UUIDs

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
url string (uri)
uuid string (uuid)
created string (date-time)
modified string (date-time)
username string
description string
error_message string
error_traceback string
state any
token string
email string (email)
expires_at string
preferred_identifier string
project string (uuid)
project_uuid string (uuid)
project_name string
customer_uuid string (uuid)
customer_name string
customer_abbreviation string

List users and their roles in a scope

Retrieves a list of users who have a role within a specific scope (e.g., a project or an organization). The list can be filtered by user details or role.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-provider-offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/list_users/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.user_role_details_field_enum import UserRoleDetailsFieldEnum # (1)
from waldur_api_client.models.user_role_details_o_enum import UserRoleDetailsOEnum # (2)
from waldur_api_client.api.marketplace_provider_offerings import marketplace_provider_offerings_list_users_list # (3)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_provider_offerings_list_users_list.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

for item in response:
    print(item)
  1. Model Source: UserRoleDetailsFieldEnum
  2. Model Source: UserRoleDetailsOEnum
  3. API Source: marketplace_provider_offerings_list_users_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceProviderOfferingsListUsersList } from 'waldur-js-client';

try {
  const response = await marketplaceProviderOfferingsListUsersList({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type Description
field array Fields to include in response
full_name string User full name
native_name string User native name
o array Ordering fields
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
role string (uuid) Role UUID or name
search_string string Search string for user
user string (uuid) User UUID
user_slug string User slug
user_url string User URL
username string User username

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid)
created string (date-time)
expiration_time string (date-time)
role_name string
role_uuid string (uuid)
user_email string (email)
user_full_name string
user_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
user_uuid string (uuid)
user_image string (uri)
created_by_full_name string
created_by_uuid string (uuid)

Check user access to offering resources

Checks if a specified user has access to any non-terminated resource of this offering.

1
2
3
4
5
http \
  GET \
  https://api.example.com/api/marketplace-provider-offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/user_has_resource_access/ \
  Authorization:"Token YOUR_API_TOKEN" \
  username=="alice"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.provider_offering_details_field_enum import ProviderOfferingDetailsFieldEnum # (1)
from waldur_api_client.api.marketplace_provider_offerings import marketplace_provider_offerings_user_has_resource_access_retrieve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_provider_offerings_user_has_resource_access_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    username="alice"
)

print(response)
  1. Model Source: ProviderOfferingDetailsFieldEnum
  2. API Source: marketplace_provider_offerings_user_has_resource_access_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { marketplaceProviderOfferingsUserHasResourceAccessRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceProviderOfferingsUserHasResourceAccessRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  query: {
    "username": "alice"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type Required Description
field array
username string ✓ Username of the user to check.

200 -

Field Type Description
url string (uri)
uuid string (uuid)
created string (date-time)
name string
slug string URL-friendly identifier. Only editable by staff users.
description string
full_description string
privacy_policy_link string (uri)
access_url string (uri) Publicly accessible offering access URL
endpoints array of objects
endpoints.uuid string (uuid)
endpoints.name string
endpoints.url string URL of the access endpoint
software_catalogs array of objects
software_catalogs.uuid string (uuid)
software_catalogs.catalog any
software_catalogs.enabled_cpu_family any List of enabled CPU families: ['x86_64', 'aarch64']
software_catalogs.enabled_cpu_microarchitectures any List of enabled CPU microarchitectures: ['generic', 'zen3']
software_catalogs.package_count integer
software_catalogs.partition any
partitions array of objects
partitions.uuid string (uuid)
partitions.partition_name string Name of the SLURM partition
partitions.cpu_bind integer Default task binding policy (SLURM cpu_bind)
partitions.def_cpu_per_gpu integer Default CPUs allocated per GPU
partitions.max_cpus_per_node integer Maximum allocated CPUs per node
partitions.max_cpus_per_socket integer Maximum allocated CPUs per socket
partitions.def_mem_per_cpu integer (int64) Default memory per CPU in MB
partitions.def_mem_per_gpu integer (int64) Default memory per GPU in MB
partitions.def_mem_per_node integer (int64) Default memory per node in MB
partitions.max_mem_per_cpu integer (int64) Maximum memory per CPU in MB
partitions.max_mem_per_node integer (int64) Maximum memory per node in MB
partitions.default_time integer Default time limit in minutes
partitions.max_time integer Maximum time limit in minutes
partitions.grace_time integer Preemption grace time in seconds
partitions.max_nodes integer Maximum nodes per job
partitions.min_nodes integer Minimum nodes per job
partitions.exclusive_topo boolean Exclusive topology access required
partitions.exclusive_user boolean Exclusive user access required
partitions.priority_tier integer Priority tier for scheduling and preemption
partitions.qos string Quality of Service (QOS) name
partitions.req_resv boolean Require reservation for job allocation
roles array of objects
roles.uuid string (uuid)
roles.name string
roles.url string (uri)
customer string (uri)
customer_uuid string (uuid)
customer_name string
project string (uri)
project_uuid string (uuid)
project_name string
category string (uri)
category_uuid string (uuid)
category_title string
attributes object (free-form)
options any
resource_options any
components array of objects
components.uuid string (uuid)
components.billing_type string
Enum: fixed, usage, limit, one, few
components.type string Unique internal name of the measured unit, for example floating_ip.
components.name string Display name for the measured unit, for example, Floating IP.
components.description string
components.measured_unit string Unit of measurement, for example, GB.
components.unit_factor integer The conversion factor from backend units to measured_unit
components.limit_period any
components.limit_amount integer
components.article_code string
components.max_value integer
components.min_value integer
components.max_available_limit integer
components.is_boolean boolean
components.default_limit integer
components.factor integer
components.is_builtin boolean
components.is_prepaid boolean
components.overage_component string (uuid)
components.min_prepaid_duration integer
components.max_prepaid_duration integer
plugin_options any
secret_options any
service_attributes object (free-form)
state any
vendor_details string
getting_started string
integration_guide string
thumbnail string (uri)
order_count integer
plans array of objects
plans.url string (uri)
plans.uuid string (uuid)
plans.name string
plans.description string
plans.article_code string
plans.max_amount integer Maximum number of plans that could be active. Plan is disabled when maximum amount is reached.
plans.archived boolean Forbids creation of new resources.
plans.is_active boolean
plans.unit_price string (decimal)
plans.unit string
Enum: month, quarter, half_month, day, hour, quantity
plans.init_price number (double)
plans.switch_price number (double)
plans.backend_id string
plans.organization_groups array of objects
plans.organization_groups.uuid string (uuid)
plans.organization_groups.url string (uri)
plans.organization_groups.name string
plans.organization_groups.parent_uuid string (uuid) UUID of the parent organization group
plans.organization_groups.parent_name string Name of the parent organization group
plans.organization_groups.parent string (uri)
plans.organization_groups.customers_count integer Number of customers in this organization group
plans.components array of objects
plans.components.type string Unique internal name of the measured unit, for example floating_ip.
plans.components.name string Display name for the measured unit, for example, Floating IP.
plans.components.measured_unit string Unit of measurement, for example, GB.
plans.components.amount integer
plans.components.price string (decimal)
plans.components.future_price string (decimal)
plans.components.discount_threshold integer Minimum amount to be eligible for discount.
plans.components.discount_rate integer Discount rate in percentage.
plans.prices object (free-form)
plans.future_prices object (free-form)
plans.quotas object (free-form)
plans.resources_count integer
plans.plan_type string
plans.minimal_price number (double)
screenshots array of objects
screenshots.name string
screenshots.uuid string (uuid)
screenshots.description string
screenshots.image string (uri)
screenshots.thumbnail string (uri)
screenshots.created string (date-time)
type string
shared boolean Accessible to all customers.
billable boolean Purchase and usage is invoiced.
scope string
scope_uuid string (uuid)
scope_name string (uuid)
scope_state any
scope_error_message string
files array of objects
files.name string
files.created string (date-time)
files.file string (uri)
quotas array of objects
quotas.name string
quotas.usage integer
quotas.limit integer
paused_reason string
datacite_doi string
citation_count integer Number of citations of a DOI
latitude number (double)
longitude number (double)
country any Country code (ISO 3166-1 alpha-2)
backend_id string
backend_id_rules any Validation rules for resource backend_id: format regex and uniqueness scope.
organization_groups array of objects
organization_groups.uuid string (uuid)
organization_groups.url string (uri)
organization_groups.name string
organization_groups.parent_uuid string (uuid) UUID of the parent organization group
organization_groups.parent_name string Name of the parent organization group
organization_groups.parent string (uri)
organization_groups.customers_count integer Number of customers in this organization group
tags array of objects
tags.uuid string (uuid)
tags.name string
image string (uri)
total_customers integer
total_cost integer
total_cost_estimated integer
parent_description string
parent_uuid string (uuid)
parent_name string
backend_metadata any
has_compliance_requirements boolean
billing_type_classification string Classify offering components by billing type. Returns 'limit_only', 'usage_only', or 'mixed'.
compliance_checklist string (uri)
integration_status array of objects
integration_status.agent_type any
integration_status.status string
integration_status.last_request_timestamp string (date-time)
integration_status.service_name string
google_calendar_is_public boolean
google_calendar_link string Get the Google Calendar link for an offering.

Grant a role to a user

Assigns a specific role to a user within the current scope. An optional expiration time for the role can be set.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/marketplace-provider-offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/add_user/ \
  Authorization:"Token YOUR_API_TOKEN" \
  role="string-value" \
  user="a1b2c3d4-e5f6-7890-abcd-ef1234567890"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.user_role_create_request import UserRoleCreateRequest # (1)
from waldur_api_client.api.marketplace_provider_offerings import marketplace_provider_offerings_add_user # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = UserRoleCreateRequest(
    role="string-value",
    user="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
)
response = marketplace_provider_offerings_add_user.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: UserRoleCreateRequest
  2. API Source: marketplace_provider_offerings_add_user
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { marketplaceProviderOfferingsAddUser } from 'waldur-js-client';

try {
  const response = await marketplaceProviderOfferingsAddUser({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "role": "string-value",
    "user": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
role string ✓
user string (uuid) ✓
expiration_time string (date-time)

201 -

Field Type
expiration_time string (date-time)

400 - Validation error, for example when trying to add a user to a terminated project.

Revoke a role from a user

Removes a specific role from a user within the current scope. This effectively revokes their permissions associated with that role.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/marketplace-provider-offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/delete_user/ \
  Authorization:"Token YOUR_API_TOKEN" \
  role="string-value" \
  user="a1b2c3d4-e5f6-7890-abcd-ef1234567890"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.user_role_delete_request import UserRoleDeleteRequest # (1)
from waldur_api_client.api.marketplace_provider_offerings import marketplace_provider_offerings_delete_user # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = UserRoleDeleteRequest(
    role="string-value",
    user="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
)
response = marketplace_provider_offerings_delete_user.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: UserRoleDeleteRequest
  2. API Source: marketplace_provider_offerings_delete_user
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { marketplaceProviderOfferingsDeleteUser } from 'waldur-js-client';

try {
  const response = await marketplaceProviderOfferingsDeleteUser({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "role": "string-value",
    "user": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
role string ✓
user string (uuid) ✓
expiration_time string (date-time)

200 - Role revoked successfully.

Refresh offering user usernames

Triggers a refresh of usernames for all non-restricted users associated with this offering, based on the current username generation policy.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-provider-offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/refresh_offering_usernames/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_provider_offerings import marketplace_provider_offerings_refresh_offering_usernames # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_provider_offerings_refresh_offering_usernames.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_provider_offerings_refresh_offering_usernames
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceProviderOfferingsRefreshOfferingUsernames } from 'waldur-js-client';

try {
  const response = await marketplaceProviderOfferingsRefreshOfferingUsernames({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
status string Status of the resource response

Update a user's role expiration

Updates the expiration time for a user's existing role in the current scope. This is useful for extending or shortening the duration of a permission. To make a role permanent, set expiration_time to null.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/marketplace-provider-offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/update_user/ \
  Authorization:"Token YOUR_API_TOKEN" \
  role="string-value" \
  user="a1b2c3d4-e5f6-7890-abcd-ef1234567890"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.user_role_update_request import UserRoleUpdateRequest # (1)
from waldur_api_client.api.marketplace_provider_offerings import marketplace_provider_offerings_update_user # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = UserRoleUpdateRequest(
    role="string-value",
    user="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
)
response = marketplace_provider_offerings_update_user.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: UserRoleUpdateRequest
  2. API Source: marketplace_provider_offerings_update_user
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { marketplaceProviderOfferingsUpdateUser } from 'waldur-js-client';

try {
  const response = await marketplaceProviderOfferingsUpdateUser({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "role": "string-value",
    "user": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
role string ✓
user string (uuid) ✓
expiration_time string (date-time)

200 -

Field Type
expiration_time string (date-time)

Update user attribute config

Creates or updates the user attribute configuration for this offering. This determines which user attributes are shared with the service provider.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-provider-offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/update-user-attribute-config/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.offering_user_attribute_config_request import OfferingUserAttributeConfigRequest # (1)
from waldur_api_client.api.marketplace_provider_offerings import marketplace_provider_offerings_update_user_attribute_config # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OfferingUserAttributeConfigRequest()
response = marketplace_provider_offerings_update_user_attribute_config.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OfferingUserAttributeConfigRequest
  2. API Source: marketplace_provider_offerings_update_user_attribute_config
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceProviderOfferingsUpdateUserAttributeConfig } from 'waldur-js-client';

try {
  const response = await marketplaceProviderOfferingsUpdateUserAttributeConfig({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
offering string (uuid)
expose_username boolean
expose_full_name boolean
expose_email boolean
expose_phone_number boolean
expose_organization boolean
expose_job_title boolean
expose_affiliations boolean
expose_gender boolean
expose_personal_title boolean
expose_place_of_birth boolean
expose_country_of_residence boolean
expose_nationality boolean
expose_nationalities boolean
expose_organization_country boolean
expose_organization_type boolean
expose_organization_registry_code boolean
expose_eduperson_assurance boolean
expose_civil_number boolean
expose_birth_date boolean
expose_identity_source boolean
expose_active_isds boolean

200 -

Field Type Description
uuid string (uuid)
created string (date-time)
modified string (date-time)
offering_uuid string (uuid)
offering_name string
expose_username boolean
expose_full_name boolean
expose_email boolean
expose_phone_number boolean
expose_organization boolean
expose_job_title boolean
expose_affiliations boolean
expose_gender boolean
expose_personal_title boolean
expose_place_of_birth boolean
expose_country_of_residence boolean
expose_nationality boolean
expose_nationalities boolean
expose_organization_country boolean
expose_organization_type boolean
expose_organization_registry_code boolean
expose_eduperson_assurance boolean
expose_civil_number boolean
expose_birth_date boolean
expose_identity_source boolean
expose_active_isds boolean
exposed_fields array of strings Return list of field names currently configured for exposure.
is_default boolean Return True if this is a default (unsaved) config.

Update user attribute config

Creates or updates the user attribute configuration for this offering. This determines which user attributes are shared with the service provider.

1
2
3
4
http \
  PUT \
  https://api.example.com/api/marketplace-provider-offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/update-user-attribute-config/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.offering_user_attribute_config_request import OfferingUserAttributeConfigRequest # (1)
from waldur_api_client.api.marketplace_provider_offerings import marketplace_provider_offerings_update_user_attribute_config_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OfferingUserAttributeConfigRequest()
response = marketplace_provider_offerings_update_user_attribute_config_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OfferingUserAttributeConfigRequest
  2. API Source: marketplace_provider_offerings_update_user_attribute_config_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceProviderOfferingsUpdateUserAttributeConfigUpdate } from 'waldur-js-client';

try {
  const response = await marketplaceProviderOfferingsUpdateUserAttributeConfigUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
offering string (uuid)
expose_username boolean
expose_full_name boolean
expose_email boolean
expose_phone_number boolean
expose_organization boolean
expose_job_title boolean
expose_affiliations boolean
expose_gender boolean
expose_personal_title boolean
expose_place_of_birth boolean
expose_country_of_residence boolean
expose_nationality boolean
expose_nationalities boolean
expose_organization_country boolean
expose_organization_type boolean
expose_organization_registry_code boolean
expose_eduperson_assurance boolean
expose_civil_number boolean
expose_birth_date boolean
expose_identity_source boolean
expose_active_isds boolean

200 -

Field Type Description
uuid string (uuid)
created string (date-time)
modified string (date-time)
offering_uuid string (uuid)
offering_name string
expose_username boolean
expose_full_name boolean
expose_email boolean
expose_phone_number boolean
expose_organization boolean
expose_job_title boolean
expose_affiliations boolean
expose_gender boolean
expose_personal_title boolean
expose_place_of_birth boolean
expose_country_of_residence boolean
expose_nationality boolean
expose_nationalities boolean
expose_organization_country boolean
expose_organization_type boolean
expose_organization_registry_code boolean
expose_eduperson_assurance boolean
expose_civil_number boolean
expose_birth_date boolean
expose_identity_source boolean
expose_active_isds boolean
exposed_fields array of strings Return list of field names currently configured for exposure.
is_default boolean Return True if this is a default (unsaved) config.

Update user attribute config

Creates or updates the user attribute configuration for this offering. This determines which user attributes are shared with the service provider.

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/marketplace-provider-offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/update-user-attribute-config/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_offering_user_attribute_config_request import PatchedOfferingUserAttributeConfigRequest # (1)
from waldur_api_client.api.marketplace_provider_offerings import marketplace_provider_offerings_update_user_attribute_config_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedOfferingUserAttributeConfigRequest()
response = marketplace_provider_offerings_update_user_attribute_config_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedOfferingUserAttributeConfigRequest
  2. API Source: marketplace_provider_offerings_update_user_attribute_config_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceProviderOfferingsUpdateUserAttributeConfigPartialUpdate } from 'waldur-js-client';

try {
  const response = await marketplaceProviderOfferingsUpdateUserAttributeConfigPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
offering string (uuid)
expose_username boolean
expose_full_name boolean
expose_email boolean
expose_phone_number boolean
expose_organization boolean
expose_job_title boolean
expose_affiliations boolean
expose_gender boolean
expose_personal_title boolean
expose_place_of_birth boolean
expose_country_of_residence boolean
expose_nationality boolean
expose_nationalities boolean
expose_organization_country boolean
expose_organization_type boolean
expose_organization_registry_code boolean
expose_eduperson_assurance boolean
expose_civil_number boolean
expose_birth_date boolean
expose_identity_source boolean
expose_active_isds boolean

200 -

Field Type Description
uuid string (uuid)
created string (date-time)
modified string (date-time)
offering_uuid string (uuid)
offering_name string
expose_username boolean
expose_full_name boolean
expose_email boolean
expose_phone_number boolean
expose_organization boolean
expose_job_title boolean
expose_affiliations boolean
expose_gender boolean
expose_personal_title boolean
expose_place_of_birth boolean
expose_country_of_residence boolean
expose_nationality boolean
expose_nationalities boolean
expose_organization_country boolean
expose_organization_type boolean
expose_organization_registry_code boolean
expose_eduperson_assurance boolean
expose_civil_number boolean
expose_birth_date boolean
expose_identity_source boolean
expose_active_isds boolean
exposed_fields array of strings Return list of field names currently configured for exposure.
is_default boolean Return True if this is a default (unsaved) config.

Delete user attribute config

Deletes the user attribute configuration for this offering. The offering will fall back to system defaults.

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/marketplace-provider-offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/delete-user-attribute-config/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_provider_offerings import marketplace_provider_offerings_delete_user_attribute_config_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_provider_offerings_delete_user_attribute_config_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_provider_offerings_delete_user_attribute_config_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceProviderOfferingsDeleteUserAttributeConfigDestroy } from 'waldur-js-client';

try {
  const response = await marketplaceProviderOfferingsDeleteUserAttributeConfigDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Offering Components

Create an offering component

Adds a new custom component to an offering.

1
2
3
4
5
6
7
http \
  POST \
  https://api.example.com/api/marketplace-provider-offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/create_offering_component/ \
  Authorization:"Token YOUR_API_TOKEN" \
  billing_type="fixed" \
  type="string-value" \
  name="my-awesome-marketplace-provider-offering"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.offering_component_request import OfferingComponentRequest # (1)
from waldur_api_client.api.marketplace_provider_offerings import marketplace_provider_offerings_create_offering_component # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OfferingComponentRequest(
    billing_type="fixed",
    type="string-value",
    name="my-awesome-marketplace-provider-offering"
)
response = marketplace_provider_offerings_create_offering_component.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OfferingComponentRequest
  2. API Source: marketplace_provider_offerings_create_offering_component
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
import { marketplaceProviderOfferingsCreateOfferingComponent } from 'waldur-js-client';

try {
  const response = await marketplaceProviderOfferingsCreateOfferingComponent({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "billing_type": "fixed",
    "type": "string-value",
    "name": "my-awesome-marketplace-provider-offering"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
billing_type string ✓
Enum: fixed, usage, limit, one, few
type string ✓ Unique internal name of the measured unit, for example floating_ip.
name string ✓ Display name for the measured unit, for example, Floating IP.
description string
measured_unit string Unit of measurement, for example, GB.
unit_factor integer The conversion factor from backend units to measured_unit
limit_period any
limit_amount integer
article_code string
max_value integer
min_value integer
max_available_limit integer
is_boolean boolean
default_limit integer
is_prepaid boolean
overage_component string (uuid)
min_prepaid_duration integer
max_prepaid_duration integer

201 - No response body

Remove an offering component

Removes a custom component from an offering. Built-in components cannot be removed.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/marketplace-provider-offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/remove_offering_component/ \
  Authorization:"Token YOUR_API_TOKEN" \
  uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.remove_offering_component_request import RemoveOfferingComponentRequest # (1)
from waldur_api_client.api.marketplace_provider_offerings import marketplace_provider_offerings_remove_offering_component # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = RemoveOfferingComponentRequest(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
)
response = marketplace_provider_offerings_remove_offering_component.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: RemoveOfferingComponentRequest
  2. API Source: marketplace_provider_offerings_remove_offering_component
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { marketplaceProviderOfferingsRemoveOfferingComponent } from 'waldur-js-client';

try {
  const response = await marketplaceProviderOfferingsRemoveOfferingComponent({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
uuid string (uuid) ✓ UUID of the component to remove

200 - No response body

Update an offering component

Updates the properties of a specific component within an offering.

1
2
3
4
5
6
7
8
http \
  POST \
  https://api.example.com/api/marketplace-provider-offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/update_offering_component/ \
  Authorization:"Token YOUR_API_TOKEN" \
  uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  billing_type="fixed" \
  type="string-value" \
  name="my-awesome-marketplace-provider-offering"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.update_offering_component_request import UpdateOfferingComponentRequest # (1)
from waldur_api_client.api.marketplace_provider_offerings import marketplace_provider_offerings_update_offering_component # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = UpdateOfferingComponentRequest(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    billing_type="fixed",
    type="string-value",
    name="my-awesome-marketplace-provider-offering"
)
response = marketplace_provider_offerings_update_offering_component.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: UpdateOfferingComponentRequest
  2. API Source: marketplace_provider_offerings_update_offering_component
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
import { marketplaceProviderOfferingsUpdateOfferingComponent } from 'waldur-js-client';

try {
  const response = await marketplaceProviderOfferingsUpdateOfferingComponent({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "billing_type": "fixed",
    "type": "string-value",
    "name": "my-awesome-marketplace-provider-offering"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
uuid string (uuid) ✓
billing_type string ✓
Enum: fixed, usage, limit, one, few
type string ✓ Unique internal name of the measured unit, for example floating_ip.
name string ✓ Display name for the measured unit, for example, Floating IP.
description string
measured_unit string Unit of measurement, for example, GB.
unit_factor integer The conversion factor from backend units to measured_unit
limit_period any
limit_amount integer
article_code string
max_value integer
min_value integer
max_available_limit integer
is_boolean boolean
default_limit integer
is_prepaid boolean
overage_component string (uuid)
min_prepaid_duration integer
max_prepaid_duration integer

200 - No response body

Software Catalogs and Partitions

Add a partition to an offering

Adds a new partition configuration to an offering.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/marketplace-provider-offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/add_partition/ \
  Authorization:"Token YOUR_API_TOKEN" \
  offering="a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  partition_name="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.offering_partition_request import OfferingPartitionRequest # (1)
from waldur_api_client.api.marketplace_provider_offerings import marketplace_provider_offerings_add_partition # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OfferingPartitionRequest(
    offering="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    partition_name="string-value"
)
response = marketplace_provider_offerings_add_partition.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OfferingPartitionRequest
  2. API Source: marketplace_provider_offerings_add_partition
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { marketplaceProviderOfferingsAddPartition } from 'waldur-js-client';

try {
  const response = await marketplaceProviderOfferingsAddPartition({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "offering": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "partition_name": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
offering string (uuid) ✓
partition_name string ✓ Name of the SLURM partition
cpu_bind integer Default task binding policy (SLURM cpu_bind)
def_cpu_per_gpu integer Default CPUs allocated per GPU
max_cpus_per_node integer Maximum allocated CPUs per node
max_cpus_per_socket integer Maximum allocated CPUs per socket
def_mem_per_cpu integer (int64) Default memory per CPU in MB
def_mem_per_gpu integer (int64) Default memory per GPU in MB
def_mem_per_node integer (int64) Default memory per node in MB
max_mem_per_cpu integer (int64) Maximum memory per CPU in MB
max_mem_per_node integer (int64) Maximum memory per node in MB
default_time integer Default time limit in minutes
max_time integer Maximum time limit in minutes
grace_time integer Preemption grace time in seconds
max_nodes integer Maximum nodes per job
min_nodes integer Minimum nodes per job
exclusive_topo boolean Exclusive topology access required
exclusive_user boolean Exclusive user access required
priority_tier integer Priority tier for scheduling and preemption
qos string Quality of Service (QOS) name
req_resv boolean Require reservation for job allocation

201 -

Field Type Description
uuid string (uuid)
created string (date-time)
modified string (date-time)
offering string (uuid)
offering_name string
partition_name string Name of the SLURM partition
cpu_bind integer Default task binding policy (SLURM cpu_bind)
def_cpu_per_gpu integer Default CPUs allocated per GPU
max_cpus_per_node integer Maximum allocated CPUs per node
max_cpus_per_socket integer Maximum allocated CPUs per socket
def_mem_per_cpu integer (int64) Default memory per CPU in MB
def_mem_per_gpu integer (int64) Default memory per GPU in MB
def_mem_per_node integer (int64) Default memory per node in MB
max_mem_per_cpu integer (int64) Maximum memory per CPU in MB
max_mem_per_node integer (int64) Maximum memory per node in MB
default_time integer Default time limit in minutes
max_time integer Maximum time limit in minutes
grace_time integer Preemption grace time in seconds
max_nodes integer Maximum nodes per job
min_nodes integer Minimum nodes per job
exclusive_topo boolean Exclusive topology access required
exclusive_user boolean Exclusive user access required
priority_tier integer Priority tier for scheduling and preemption
qos string Quality of Service (QOS) name
req_resv boolean Require reservation for job allocation

Add a software catalog to an offering

Associates a software catalog with an offering and configures enabled CPU architectures.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/marketplace-provider-offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/add_software_catalog/ \
  Authorization:"Token YOUR_API_TOKEN" \
  offering="a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  catalog="a1b2c3d4-e5f6-7890-abcd-ef1234567890"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.offering_software_catalog_request import OfferingSoftwareCatalogRequest # (1)
from waldur_api_client.api.marketplace_provider_offerings import marketplace_provider_offerings_add_software_catalog # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OfferingSoftwareCatalogRequest(
    offering="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    catalog="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
)
response = marketplace_provider_offerings_add_software_catalog.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OfferingSoftwareCatalogRequest
  2. API Source: marketplace_provider_offerings_add_software_catalog
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { marketplaceProviderOfferingsAddSoftwareCatalog } from 'waldur-js-client';

try {
  const response = await marketplaceProviderOfferingsAddSoftwareCatalog({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "offering": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "catalog": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
offering string (uuid) ✓
catalog string (uuid) ✓
enabled_cpu_family any List of enabled CPU families: ['x86_64', 'aarch64']
enabled_cpu_microarchitectures any List of enabled CPU microarchitectures: ['generic', 'zen3']
partition string (uuid)

201 -

Field Type Description
uuid string (uuid) UUID of the software catalog

Remove a partition from an offering

Removes a partition configuration from an offering.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/marketplace-provider-offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/remove_partition/ \
  Authorization:"Token YOUR_API_TOKEN" \
  partition_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.remove_partition_request import RemovePartitionRequest # (1)
from waldur_api_client.api.marketplace_provider_offerings import marketplace_provider_offerings_remove_partition # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = RemovePartitionRequest(
    partition_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
)
response = marketplace_provider_offerings_remove_partition.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: RemovePartitionRequest
  2. API Source: marketplace_provider_offerings_remove_partition
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { marketplaceProviderOfferingsRemovePartition } from 'waldur-js-client';

try {
  const response = await marketplaceProviderOfferingsRemovePartition({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "partition_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
partition_uuid string (uuid) ✓

204 - No response body

Remove a software catalog from an offering

Disassociates a software catalog from an offering.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/marketplace-provider-offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/remove_software_catalog/ \
  Authorization:"Token YOUR_API_TOKEN" \
  offering_catalog_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.remove_software_catalog_request import RemoveSoftwareCatalogRequest # (1)
from waldur_api_client.api.marketplace_provider_offerings import marketplace_provider_offerings_remove_software_catalog # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = RemoveSoftwareCatalogRequest(
    offering_catalog_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
)
response = marketplace_provider_offerings_remove_software_catalog.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: RemoveSoftwareCatalogRequest
  2. API Source: marketplace_provider_offerings_remove_software_catalog
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { marketplaceProviderOfferingsRemoveSoftwareCatalog } from 'waldur-js-client';

try {
  const response = await marketplaceProviderOfferingsRemoveSoftwareCatalog({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "offering_catalog_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
offering_catalog_uuid string (uuid) ✓ UUID of the offering catalog to remove

204 - No response body

Update a partition of an offering

Updates the configuration of an existing partition associated with an offering.

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/marketplace-provider-offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/update_partition/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_offering_partition_update_request import PatchedOfferingPartitionUpdateRequest # (1)
from waldur_api_client.api.marketplace_provider_offerings import marketplace_provider_offerings_update_partition_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedOfferingPartitionUpdateRequest()
response = marketplace_provider_offerings_update_partition_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedOfferingPartitionUpdateRequest
  2. API Source: marketplace_provider_offerings_update_partition_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceProviderOfferingsUpdatePartitionPartialUpdate } from 'waldur-js-client';

try {
  const response = await marketplaceProviderOfferingsUpdatePartitionPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
partition_uuid string (uuid)
Constraints: write-only
partition_name string Name of the SLURM partition
cpu_bind integer Default task binding policy (SLURM cpu_bind)
def_cpu_per_gpu integer Default CPUs allocated per GPU
max_cpus_per_node integer Maximum allocated CPUs per node
max_cpus_per_socket integer Maximum allocated CPUs per socket
def_mem_per_cpu integer (int64) Default memory per CPU in MB
def_mem_per_gpu integer (int64) Default memory per GPU in MB
def_mem_per_node integer (int64) Default memory per node in MB
max_mem_per_cpu integer (int64) Maximum memory per CPU in MB
max_mem_per_node integer (int64) Maximum memory per node in MB
default_time integer Default time limit in minutes
max_time integer Maximum time limit in minutes
grace_time integer Preemption grace time in seconds
max_nodes integer Maximum nodes per job
min_nodes integer Minimum nodes per job
exclusive_topo boolean Exclusive topology access required
exclusive_user boolean Exclusive user access required
priority_tier integer Priority tier for scheduling and preemption
qos string Quality of Service (QOS) name
req_resv boolean Require reservation for job allocation

200 -

Field Type Description
uuid string (uuid)
created string (date-time)
modified string (date-time)
offering string (uuid)
offering_name string
partition_name string Name of the SLURM partition
cpu_bind integer Default task binding policy (SLURM cpu_bind)
def_cpu_per_gpu integer Default CPUs allocated per GPU
max_cpus_per_node integer Maximum allocated CPUs per node
max_cpus_per_socket integer Maximum allocated CPUs per socket
def_mem_per_cpu integer (int64) Default memory per CPU in MB
def_mem_per_gpu integer (int64) Default memory per GPU in MB
def_mem_per_node integer (int64) Default memory per node in MB
max_mem_per_cpu integer (int64) Maximum memory per CPU in MB
max_mem_per_node integer (int64) Maximum memory per node in MB
default_time integer Default time limit in minutes
max_time integer Maximum time limit in minutes
grace_time integer Preemption grace time in seconds
max_nodes integer Maximum nodes per job
min_nodes integer Minimum nodes per job
exclusive_topo boolean Exclusive topology access required
exclusive_user boolean Exclusive user access required
priority_tier integer Priority tier for scheduling and preemption
qos string Quality of Service (QOS) name
req_resv boolean Require reservation for job allocation

Update software catalog configuration

Updates the configuration of a software catalog associated with an offering, such as enabled architectures or partition.

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/marketplace-provider-offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/update_software_catalog/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_offering_software_catalog_update_request import PatchedOfferingSoftwareCatalogUpdateRequest # (1)
from waldur_api_client.api.marketplace_provider_offerings import marketplace_provider_offerings_update_software_catalog_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedOfferingSoftwareCatalogUpdateRequest()
response = marketplace_provider_offerings_update_software_catalog_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedOfferingSoftwareCatalogUpdateRequest
  2. API Source: marketplace_provider_offerings_update_software_catalog_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceProviderOfferingsUpdateSoftwareCatalogPartialUpdate } from 'waldur-js-client';

try {
  const response = await marketplaceProviderOfferingsUpdateSoftwareCatalogPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
offering_catalog_uuid string (uuid)
Constraints: write-only
catalog string (uuid)
enabled_cpu_family any List of enabled CPU families: ['x86_64', 'aarch64']
enabled_cpu_microarchitectures any List of enabled CPU microarchitectures: ['generic', 'zen3']
partition string (uuid)

200 -

Field Type Description
uuid string (uuid)
created string (date-time)
modified string (date-time)
offering string (uuid)
catalog string (uuid)
offering_name string
catalog_name string
catalog_version string
enabled_cpu_family any List of enabled CPU families: ['x86_64', 'aarch64']
enabled_cpu_microarchitectures any List of enabled CPU microarchitectures: ['generic', 'zen3']
partition string (uuid)
partition_name string

Endpoints

Add an access endpoint to an offering

Adds a new access endpoint (URL) to an offering.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/marketplace-provider-offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/add_endpoint/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-marketplace-provider-offering" \
  url="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.nested_endpoint_request import NestedEndpointRequest # (1)
from waldur_api_client.api.marketplace_provider_offerings import marketplace_provider_offerings_add_endpoint # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = NestedEndpointRequest(
    name="my-awesome-marketplace-provider-offering",
    url="string-value"
)
response = marketplace_provider_offerings_add_endpoint.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: NestedEndpointRequest
  2. API Source: marketplace_provider_offerings_add_endpoint
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { marketplaceProviderOfferingsAddEndpoint } from 'waldur-js-client';

try {
  const response = await marketplaceProviderOfferingsAddEndpoint({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-marketplace-provider-offering",
    "url": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
name string ✓
url string ✓ URL of the access endpoint

201 -

Field Type Description
uuid string (uuid) UUID of the access endpoint

Delete an access endpoint from an offering

Deletes an existing access endpoint from an offering by its UUID.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/marketplace-provider-offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/delete_endpoint/ \
  Authorization:"Token YOUR_API_TOKEN" \
  uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.endpoint_uuid_request import EndpointUUIDRequest # (1)
from waldur_api_client.api.marketplace_provider_offerings import marketplace_provider_offerings_delete_endpoint # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = EndpointUUIDRequest(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
)
response = marketplace_provider_offerings_delete_endpoint.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: EndpointUUIDRequest
  2. API Source: marketplace_provider_offerings_delete_endpoint
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { marketplaceProviderOfferingsDeleteEndpoint } from 'waldur-js-client';

try {
  const response = await marketplaceProviderOfferingsDeleteEndpoint({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
uuid string (uuid) ✓ UUID of the access endpoint

204 - No response body

Attachments and Images

Delete offering image

Deletes the main image of an offering.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-provider-offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/delete_image/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_provider_offerings import marketplace_provider_offerings_delete_image # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_provider_offerings_delete_image.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_provider_offerings_delete_image
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceProviderOfferingsDeleteImage } from 'waldur-js-client';

try {
  const response = await marketplaceProviderOfferingsDeleteImage({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Delete offering thumbnail

Deletes the thumbnail image of an offering.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-provider-offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/delete_thumbnail/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_provider_offerings import marketplace_provider_offerings_delete_thumbnail # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_provider_offerings_delete_thumbnail.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_provider_offerings_delete_thumbnail
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceProviderOfferingsDeleteThumbnail } from 'waldur-js-client';

try {
  const response = await marketplaceProviderOfferingsDeleteThumbnail({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Update offering image

Uploads or replaces the main image for an offering.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/marketplace-provider-offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/update_image/ \
  Authorization:"Token YOUR_API_TOKEN" \
  image="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.offering_image_request import OfferingImageRequest # (1)
from waldur_api_client.api.marketplace_provider_offerings import marketplace_provider_offerings_update_image # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OfferingImageRequest(
    image="string-value"
)
response = marketplace_provider_offerings_update_image.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OfferingImageRequest
  2. API Source: marketplace_provider_offerings_update_image
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { marketplaceProviderOfferingsUpdateImage } from 'waldur-js-client';

try {
  const response = await marketplaceProviderOfferingsUpdateImage({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "image": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
image string (binary) ✓

200 - No response body

Update offering thumbnail

Uploads or replaces the thumbnail image for an offering.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/marketplace-provider-offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/update_thumbnail/ \
  Authorization:"Token YOUR_API_TOKEN" \
  thumbnail="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.offering_thumbnail_request import OfferingThumbnailRequest # (1)
from waldur_api_client.api.marketplace_provider_offerings import marketplace_provider_offerings_update_thumbnail # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OfferingThumbnailRequest(
    thumbnail="string-value"
)
response = marketplace_provider_offerings_update_thumbnail.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OfferingThumbnailRequest
  2. API Source: marketplace_provider_offerings_update_thumbnail
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { marketplaceProviderOfferingsUpdateThumbnail } from 'waldur-js-client';

try {
  const response = await marketplaceProviderOfferingsUpdateThumbnail({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "thumbnail": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
thumbnail string (binary) ✓

200 - No response body

Configuration & Updates

Delete organization groups for offering

Removes all organization group associations from this offering, making it accessible to all.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-provider-offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/delete_organization_groups/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_provider_offerings import marketplace_provider_offerings_delete_organization_groups # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_provider_offerings_delete_organization_groups.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_provider_offerings_delete_organization_groups
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceProviderOfferingsDeleteOrganizationGroups } from 'waldur-js-client';

try {
  const response = await marketplaceProviderOfferingsDeleteOrganizationGroups({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Move an offering

Moves an offering to a different service provider. Requires staff permissions.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/marketplace-provider-offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/move_offering/ \
  Authorization:"Token YOUR_API_TOKEN" \
  customer="https://api.example.com/api/customer/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  preserve_permissions=true

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.move_offering_request import MoveOfferingRequest # (1)
from waldur_api_client.api.marketplace_provider_offerings import marketplace_provider_offerings_move_offering # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = MoveOfferingRequest(
    customer="https://api.example.com/api/customer/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    preserve_permissions=true
)
response = marketplace_provider_offerings_move_offering.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: MoveOfferingRequest
  2. API Source: marketplace_provider_offerings_move_offering
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { marketplaceProviderOfferingsMoveOffering } from 'waldur-js-client';

try {
  const response = await marketplaceProviderOfferingsMoveOffering({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "customer": "https://api.example.com/api/customer/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "preserve_permissions": true
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
customer string (uri) ✓ Target customer URL with service provider profile where the offering should be moved
preserve_permissions boolean ✓ Whether to preserve existing permissions when moving the offering

200 -

Field Type Description
url string (uri)
uuid string (uuid)
created string (date-time)
name string
slug string URL-friendly identifier. Only editable by staff users.
description string
full_description string
privacy_policy_link string (uri)
access_url string (uri) Publicly accessible offering access URL
endpoints array of objects
endpoints.uuid string (uuid)
endpoints.name string
endpoints.url string URL of the access endpoint
software_catalogs array of objects
software_catalogs.uuid string (uuid)
software_catalogs.catalog any
software_catalogs.enabled_cpu_family any List of enabled CPU families: ['x86_64', 'aarch64']
software_catalogs.enabled_cpu_microarchitectures any List of enabled CPU microarchitectures: ['generic', 'zen3']
software_catalogs.package_count integer
software_catalogs.partition any
partitions array of objects
partitions.uuid string (uuid)
partitions.partition_name string Name of the SLURM partition
partitions.cpu_bind integer Default task binding policy (SLURM cpu_bind)
partitions.def_cpu_per_gpu integer Default CPUs allocated per GPU
partitions.max_cpus_per_node integer Maximum allocated CPUs per node
partitions.max_cpus_per_socket integer Maximum allocated CPUs per socket
partitions.def_mem_per_cpu integer (int64) Default memory per CPU in MB
partitions.def_mem_per_gpu integer (int64) Default memory per GPU in MB
partitions.def_mem_per_node integer (int64) Default memory per node in MB
partitions.max_mem_per_cpu integer (int64) Maximum memory per CPU in MB
partitions.max_mem_per_node integer (int64) Maximum memory per node in MB
partitions.default_time integer Default time limit in minutes
partitions.max_time integer Maximum time limit in minutes
partitions.grace_time integer Preemption grace time in seconds
partitions.max_nodes integer Maximum nodes per job
partitions.min_nodes integer Minimum nodes per job
partitions.exclusive_topo boolean Exclusive topology access required
partitions.exclusive_user boolean Exclusive user access required
partitions.priority_tier integer Priority tier for scheduling and preemption
partitions.qos string Quality of Service (QOS) name
partitions.req_resv boolean Require reservation for job allocation
roles array of objects
roles.uuid string (uuid)
roles.name string
roles.url string (uri)
customer string (uri)
customer_uuid string (uuid)
customer_name string
project string (uri)
project_uuid string (uuid)
project_name string
category string (uri)
category_uuid string (uuid)
category_title string
attributes object (free-form)
options any
resource_options any
components array of objects
components.uuid string (uuid)
components.billing_type string
Enum: fixed, usage, limit, one, few
components.type string Unique internal name of the measured unit, for example floating_ip.
components.name string Display name for the measured unit, for example, Floating IP.
components.description string
components.measured_unit string Unit of measurement, for example, GB.
components.unit_factor integer The conversion factor from backend units to measured_unit
components.limit_period any
components.limit_amount integer
components.article_code string
components.max_value integer
components.min_value integer
components.max_available_limit integer
components.is_boolean boolean
components.default_limit integer
components.factor integer
components.is_builtin boolean
components.is_prepaid boolean
components.overage_component string (uuid)
components.min_prepaid_duration integer
components.max_prepaid_duration integer
plugin_options any
state any
vendor_details string
getting_started string
integration_guide string
thumbnail string (uri)
order_count integer
plans array of objects
plans.url string (uri)
plans.uuid string (uuid)
plans.name string
plans.description string
plans.article_code string
plans.max_amount integer Maximum number of plans that could be active. Plan is disabled when maximum amount is reached.
plans.archived boolean Forbids creation of new resources.
plans.is_active boolean
plans.unit_price string (decimal)
plans.unit string
Enum: month, quarter, half_month, day, hour, quantity
plans.init_price number (double)
plans.switch_price number (double)
plans.backend_id string
plans.organization_groups array of objects
plans.organization_groups.uuid string (uuid)
plans.organization_groups.url string (uri)
plans.organization_groups.name string
plans.organization_groups.parent_uuid string (uuid) UUID of the parent organization group
plans.organization_groups.parent_name string Name of the parent organization group
plans.organization_groups.parent string (uri)
plans.organization_groups.customers_count integer Number of customers in this organization group
plans.components array of objects
plans.components.type string Unique internal name of the measured unit, for example floating_ip.
plans.components.name string Display name for the measured unit, for example, Floating IP.
plans.components.measured_unit string Unit of measurement, for example, GB.
plans.components.amount integer
plans.components.price string (decimal)
plans.components.future_price string (decimal)
plans.components.discount_threshold integer Minimum amount to be eligible for discount.
plans.components.discount_rate integer Discount rate in percentage.
plans.prices object (free-form)
plans.future_prices object (free-form)
plans.quotas object (free-form)
plans.resources_count integer
plans.plan_type string
plans.minimal_price number (double)
screenshots array of objects
screenshots.name string
screenshots.uuid string (uuid)
screenshots.description string
screenshots.image string (uri)
screenshots.thumbnail string (uri)
screenshots.created string (date-time)
type string
shared boolean Accessible to all customers.
billable boolean Purchase and usage is invoiced.
scope string
scope_uuid string (uuid)
scope_name string (uuid)
scope_state any
scope_error_message string
files array of objects
files.name string
files.created string (date-time)
files.file string (uri)
quotas array of objects
quotas.name string
quotas.usage integer
quotas.limit integer
paused_reason string
datacite_doi string
citation_count integer Number of citations of a DOI
latitude number (double)
longitude number (double)
country any Country code (ISO 3166-1 alpha-2)
backend_id string
organization_groups array of objects
organization_groups.uuid string (uuid)
organization_groups.url string (uri)
organization_groups.name string
organization_groups.parent_uuid string (uuid) UUID of the parent organization group
organization_groups.parent_name string Name of the parent organization group
organization_groups.parent string (uri)
organization_groups.customers_count integer Number of customers in this organization group
tags array of objects
tags.uuid string (uuid)
tags.name string
image string (uri)
total_customers integer
total_cost integer
total_cost_estimated integer
parent_description string
parent_uuid string (uuid)
parent_name string
backend_metadata any
has_compliance_requirements boolean
billing_type_classification string Classify offering components by billing type. Returns 'limit_only', 'usage_only', or 'mixed'.
compliance_checklist string (uri)
user_has_consent boolean
is_accessible boolean
google_calendar_is_public boolean
google_calendar_link string Get the Google Calendar link for an offering.
promotion_campaigns array of objects
promotion_campaigns.uuid string (uuid)
promotion_campaigns.name string
promotion_campaigns.start_date string (date) Starting from this date, the campaign is active.
promotion_campaigns.end_date string (date) The last day the campaign is active.
promotion_campaigns.discount_type string
Enum: discount, special_price
promotion_campaigns.discount integer
promotion_campaigns.stock integer
promotion_campaigns.description string
promotion_campaigns.months integer How many months in a row should the related service (when activated) get special deal (0 for indefinitely until active)
promotion_campaigns.service_provider string (uri)

Set offering backend metadata

Updates the backend-specific metadata for an offering.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-provider-offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_backend_metadata/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.offering_backend_metadata_request import OfferingBackendMetadataRequest # (1)
from waldur_api_client.api.marketplace_provider_offerings import marketplace_provider_offerings_set_backend_metadata # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OfferingBackendMetadataRequest()
response = marketplace_provider_offerings_set_backend_metadata.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OfferingBackendMetadataRequest
  2. API Source: marketplace_provider_offerings_set_backend_metadata
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceProviderOfferingsSetBackendMetadata } from 'waldur-js-client';

try {
  const response = await marketplaceProviderOfferingsSetBackendMetadata({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
backend_metadata any

200 - No response body

Update offering attributes

Updates the attributes of an offering.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-provider-offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/update_attributes/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_provider_offerings import marketplace_provider_offerings_update_attributes # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_provider_offerings_update_attributes.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_provider_offerings_update_attributes
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceProviderOfferingsUpdateAttributes } from 'waldur-js-client';

try {
  const response = await marketplaceProviderOfferingsUpdateAttributes({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 - No response body

Update offering compliance checklist

Associates a compliance checklist with an offering.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-provider-offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/update_compliance_checklist/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.offering_compliance_checklist_update_request import OfferingComplianceChecklistUpdateRequest # (1)
from waldur_api_client.api.marketplace_provider_offerings import marketplace_provider_offerings_update_compliance_checklist # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OfferingComplianceChecklistUpdateRequest()
response = marketplace_provider_offerings_update_compliance_checklist.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OfferingComplianceChecklistUpdateRequest
  2. API Source: marketplace_provider_offerings_update_compliance_checklist
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceProviderOfferingsUpdateComplianceChecklist } from 'waldur-js-client';

try {
  const response = await marketplaceProviderOfferingsUpdateComplianceChecklist({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
compliance_checklist string (uuid)

200 - No response body

Update offering category

Updates the category of an offering.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/marketplace-provider-offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/update_description/ \
  Authorization:"Token YOUR_API_TOKEN" \
  category="https://api.example.com/api/category/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.offering_description_update_request import OfferingDescriptionUpdateRequest # (1)
from waldur_api_client.api.marketplace_provider_offerings import marketplace_provider_offerings_update_description # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OfferingDescriptionUpdateRequest(
    category="https://api.example.com/api/category/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = marketplace_provider_offerings_update_description.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OfferingDescriptionUpdateRequest
  2. API Source: marketplace_provider_offerings_update_description
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { marketplaceProviderOfferingsUpdateDescription } from 'waldur-js-client';

try {
  const response = await marketplaceProviderOfferingsUpdateDescription({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "category": "https://api.example.com/api/category/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
category string (uri) ✓

200 - No response body

Update offering integration settings

Updates the backend integration settings for an offering, including plugin options, secret options, and service attributes.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-provider-offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/update_integration/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.offering_integration_update_request import OfferingIntegrationUpdateRequest # (1)
from waldur_api_client.api.marketplace_provider_offerings import marketplace_provider_offerings_update_integration # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OfferingIntegrationUpdateRequest()
response = marketplace_provider_offerings_update_integration.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OfferingIntegrationUpdateRequest
  2. API Source: marketplace_provider_offerings_update_integration
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceProviderOfferingsUpdateIntegration } from 'waldur-js-client';

try {
  const response = await marketplaceProviderOfferingsUpdateIntegration({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
secret_options object
secret_options.heappe_cluster_password string HEAppE cluster password
secret_options.heappe_password string HEAppE password
secret_options.ipv4_external_ip_mapping array of objects OpenStack IPv4 external IP mapping
secret_options.ipv4_external_ip_mapping.floating_ip string ✓ Floating IP
secret_options.ipv4_external_ip_mapping.external_ip string ✓ External IP
secret_options.openstack_api_tls_certificate string TLS certificate for OpenStack API connection verification
secret_options.dns_nameservers array of strings Default value for new subnets DNS name servers. Should be defined as list.
secret_options.shared_user_password string GLAuth shared user password
secret_options.template_confirmation_comment string Template confirmation comment
secret_options.language string Script language: Python or Bash
secret_options.environ any Script environment variables
secret_options.create string Script for resource creation
secret_options.terminate string Script for resource termination
secret_options.update string Script for resource update
secret_options.pull string Script for regular resource pull
secret_options.api_url string API URL
secret_options.token string Waldur access token
secret_options.customer_uuid string Organization UUID
secret_options.backend_url string
secret_options.username string
secret_options.password string
secret_options.cloud_init_template string Cloud-init template for Rancher cluster node initialization
secret_options.managed_rancher_load_balancer_cloud_init_template string Cloud-init template for managed Rancher load balancer initialization
secret_options.vault_host string Host of the Vault server
secret_options.vault_port integer Port of the Vault server
secret_options.vault_token string Token for the Vault server
secret_options.vault_tls_verify boolean Whether to verify the Vault server certificate
secret_options.keycloak_url string URL of the Keycloak server
secret_options.keycloak_realm string Keycloak realm for Rancher
secret_options.keycloak_user_realm string Keycloak user realm for auth
secret_options.keycloak_username string Username of the Keycloak integration user
secret_options.keycloak_password string Password of the Keycloak integration user
secret_options.keycloak_sync_frequency integer Frequency in minutes for syncing Keycloak users
secret_options.keycloak_ssl_verify boolean Indicates whether verify SSL certificates
secret_options.argocd_k8s_namespace string Namespace where ArgoCD is deployed
secret_options.argocd_k8s_kubeconfig string Kubeconfig with access to namespace where ArgoCD is deployed
secret_options.base_image_name string Base image name
secret_options.private_registry_url string URL of a private registry for a cluster
secret_options.private_registry_user string Username for accessing a private registry
secret_options.private_registry_password string Password for accessing a private registry
secret_options.k8s_version string Kubernetes version
secret_options.node_disk_driver any OpenStack disk driver for Rancher nodes
plugin_options object
plugin_options.auto_approve_remote_orders boolean If set to True, an order can be processed without approval
plugin_options.resource_expiration_threshold integer Resource expiration threshold in days.
Constraints: default: 30
plugin_options.service_provider_can_create_offering_user boolean Service provider can create offering user
plugin_options.max_resource_termination_offset_in_days integer Maximum resource termination offset in days
plugin_options.default_resource_termination_offset_in_days integer If set, it will be used as a default resource termination offset in days
plugin_options.is_resource_termination_date_required boolean If set to True, resource termination date is required
plugin_options.latest_date_for_resource_termination string If set, it will be used as a latest date for resource termination. Format: YYYY-MM-DD
plugin_options.auto_approve_in_service_provider_projects boolean Skip approval of public offering belonging to the same organization under which the request is done
plugin_options.disable_autoapprove boolean If set to True, orders for this offering will always require manual approval, overriding auto_approve_in_service_provider_projects
plugin_options.supports_downscaling boolean If set to True, it will be possible to downscale resources
plugin_options.supports_pausing boolean If set to True, it will be possible to pause resources
plugin_options.minimal_team_count_for_provisioning integer Minimal team count required for provisioning of resources
plugin_options.maximal_resource_count_per_project integer Maximal number of offering resources allowed per project
plugin_options.unique_resource_per_attribute string Attribute name to enforce uniqueness per value. E.g., 'storage_data_type' ensures only one resource per storage type per project.
plugin_options.required_team_role_for_provisioning string Required user role in a project for provisioning of resources
plugin_options.enable_purchase_order_upload boolean If set to True, users will be able to upload purchase orders.
plugin_options.require_purchase_order_upload boolean If set to True, users will be required to upload purchase orders.
plugin_options.conceal_billing_data boolean If set to True, pricing and components tab would be concealed.
plugin_options.create_orders_on_resource_option_change boolean If set to True, create orders when options of related resources are changed.
plugin_options.can_restore_resource boolean If set to True, resource can be restored.
plugin_options.enable_provider_consumer_messaging boolean If set to True, service providers can send messages with attachments to consumers on pending orders, and consumers can respond.
plugin_options.notify_about_provider_consumer_messages boolean If set to True, send email notifications when providers or consumers exchange messages on pending orders.
plugin_options.restrict_deletion_with_active_resources boolean If set to True, offering cannot be deleted while it has non-terminated resources.
plugin_options.resource_name_pattern string Python format string for generating resource names. Available variables: {customer_name}, {customer_slug}, {project_name}, {project_slug}, {offering_name}, {offering_slug}, {plan_name}, {counter}, {attributes[KEY]}.
plugin_options.default_internal_network_mtu integer If set, it will be used as a default MTU for the first network in a tenant
plugin_options.max_instances integer Default limit for number of instances in OpenStack tenant
plugin_options.max_volumes integer Default limit for number of volumes in OpenStack tenant
plugin_options.max_security_groups integer Default limit for number of security groups in OpenStack tenant
plugin_options.storage_mode any Storage mode for OpenStack offering
plugin_options.snapshot_size_limit_gb integer Default limit for snapshot size in GB
plugin_options.heappe_cluster_id string HEAppE cluster id
plugin_options.heappe_local_base_path string HEAppE local base path
plugin_options.heappe_url string HEAppE url
plugin_options.heappe_username string HEAppE username
plugin_options.homedir_prefix string GLAuth homedir prefix
Constraints: default: /home/
plugin_options.scratch_project_directory string HEAppE scratch project directory
plugin_options.project_permanent_directory string HEAppE project permanent directory
plugin_options.initial_primarygroup_number integer GLAuth initial primary group number
Constraints: default: 5000
plugin_options.initial_uidnumber integer GLAuth initial uidnumber
Constraints: default: 5000
plugin_options.initial_usergroup_number integer GLAuth initial usergroup number
Constraints: default: 6000
plugin_options.username_anonymized_prefix string GLAuth prefix for anonymized usernames
Constraints: default: waldur_
plugin_options.username_generation_policy any GLAuth username generation policy
Constraints: default: service_provider
plugin_options.enable_issues_for_membership_changes boolean Enable issues for membership changes
plugin_options.deployment_mode any Rancher deployment mode
plugin_options.flavors_regex string Regular expression to limit flavors list
plugin_options.openstack_offering_uuid_list array of strings List of UUID of OpenStack offerings where tenant can be created
plugin_options.managed_rancher_server_flavor_name string Flavor name for managed Rancher server instances
plugin_options.managed_rancher_server_system_volume_size_gb integer System volume size in GB for managed Rancher server
plugin_options.managed_rancher_server_system_volume_type_name string System volume type name for managed Rancher server
plugin_options.managed_rancher_server_data_volume_size_gb integer Data volume size in GB for managed Rancher server
plugin_options.managed_rancher_server_data_volume_type_name string Data volume type name for managed Rancher server
plugin_options.managed_rancher_worker_system_volume_size_gb integer System volume size in GB for managed Rancher worker nodes
plugin_options.managed_rancher_worker_system_volume_type_name string System volume type name for managed Rancher worker nodes
plugin_options.managed_rancher_load_balancer_flavor_name string Flavor name for managed Rancher load balancer
plugin_options.managed_rancher_load_balancer_system_volume_size_gb integer System volume size in GB for managed Rancher load balancer
plugin_options.managed_rancher_load_balancer_system_volume_type_name string System volume type name for managed Rancher load balancer
plugin_options.managed_rancher_load_balancer_data_volume_size_gb integer Data volume size in GB for managed Rancher load balancer
plugin_options.managed_rancher_load_balancer_data_volume_type_name string Data volume type name for managed Rancher load balancer
plugin_options.managed_rancher_tenant_max_cpu integer Max number of vCPUs for tenants
plugin_options.managed_rancher_tenant_max_ram integer Max number of RAM for tenants (GB)
plugin_options.managed_rancher_tenant_max_disk integer Max size of disk space for tenants (GB)
plugin_options.account_name_generation_policy any Slurm account name generation policy
plugin_options.enable_display_of_order_actions_for_service_provider boolean Enable display of order actions for service provider
Constraints: default: True
plugin_options.slurm_periodic_policy_enabled boolean Enable SLURM periodic usage policy configuration. When enabled, allows configuring QoS-based threshold enforcement, carryover logic, and fairshare decay for site-agent managed SLURM offerings.
Constraints: default: False
plugin_options.auto_approve_marketplace_script boolean If set to False, all orders require manual provider approval, including for service provider owners and staff
Constraints: default: True
plugin_options.keycloak_enabled boolean If set to True, Keycloak group management is enabled for this offering.
plugin_options.keycloak_base_group string Root parent group in Keycloak under which offering groups are created. Groups are organized as: {base_group}/{offering_slug}/{role_group}. If empty, offering groups are created at the realm root.
plugin_options.keycloak_sync_frequency integer Frequency in minutes for syncing Keycloak group memberships.
plugin_options.keycloak_group_name_template string Template for generating Keycloak group names. Uses $variable syntax (e.g. $offering_uuid_$role_name). Allowed variables: offering_uuid, offering_name, offering_slug, resource_uuid, resource_name, resource_slug, project_uuid, project_name, project_slug, organization_uuid, organization_name, organization_slug, role_name, scope_id.
plugin_options.keycloak_username_label string Custom label for the username field when inviting external users (e.g. 'Civil code', 'CUID'). If empty, defaults to 'Username'.
Constraints: default: ``
plugin_options.highlight_backend_id_display boolean Defines if backend_id should be shown more prominently by the UI
Constraints: default: False
plugin_options.backend_id_display_label string Label used by UI for showing value of the backend_id
Constraints: default: Backend ID
plugin_options.disabled_resource_actions array of strings List of disabled marketplace resource actions for this offering.
service_attributes any
backend_id string

200 - No response body

Update offering location

Updates the geographical location (latitude and longitude) of an offering.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/marketplace-provider-offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/update_location/ \
  Authorization:"Token YOUR_API_TOKEN" \
  latitude=123.45 \
  longitude=123.45

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.offering_location_update_request import OfferingLocationUpdateRequest # (1)
from waldur_api_client.api.marketplace_provider_offerings import marketplace_provider_offerings_update_location # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OfferingLocationUpdateRequest(
    latitude=123.45,
    longitude=123.45
)
response = marketplace_provider_offerings_update_location.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OfferingLocationUpdateRequest
  2. API Source: marketplace_provider_offerings_update_location
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { marketplaceProviderOfferingsUpdateLocation } from 'waldur-js-client';

try {
  const response = await marketplaceProviderOfferingsUpdateLocation({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "latitude": 123.45,
    "longitude": 123.45
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
latitude number (double) ✓
longitude number (double) ✓

200 - No response body

Update offering options

Updates the order form options for an offering.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/marketplace-provider-offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/update_options/ \
  Authorization:"Token YOUR_API_TOKEN" \
  options:='{}'

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.offering_options_update_request import OfferingOptionsUpdateRequest # (1)
from waldur_api_client.api.marketplace_provider_offerings import marketplace_provider_offerings_update_options # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OfferingOptionsUpdateRequest(
    options={}
)
response = marketplace_provider_offerings_update_options.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OfferingOptionsUpdateRequest
  2. API Source: marketplace_provider_offerings_update_options
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { marketplaceProviderOfferingsUpdateOptions } from 'waldur-js-client';

try {
  const response = await marketplaceProviderOfferingsUpdateOptions({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "options": {}
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
options object ✓
options.order array of strings ✓
options.options object (free-form) ✓

200 - No response body

Update organization groups for offering

Sets the list of organization groups that can access this offering.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-provider-offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/update_organization_groups/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.organization_groups_request import OrganizationGroupsRequest # (1)
from waldur_api_client.api.marketplace_provider_offerings import marketplace_provider_offerings_update_organization_groups # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OrganizationGroupsRequest()
response = marketplace_provider_offerings_update_organization_groups.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OrganizationGroupsRequest
  2. API Source: marketplace_provider_offerings_update_organization_groups
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceProviderOfferingsUpdateOrganizationGroups } from 'waldur-js-client';

try {
  const response = await marketplaceProviderOfferingsUpdateOrganizationGroups({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
organization_groups array of string (uri)s

200 - No response body

Update offering overview

Updates the overview fields of an offering, such as name, description, and getting started guide.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/marketplace-provider-offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/update_overview/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-marketplace-provider-offering"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.offering_overview_update_request import OfferingOverviewUpdateRequest # (1)
from waldur_api_client.api.marketplace_provider_offerings import marketplace_provider_offerings_update_overview # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OfferingOverviewUpdateRequest(
    name="my-awesome-marketplace-provider-offering"
)
response = marketplace_provider_offerings_update_overview.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OfferingOverviewUpdateRequest
  2. API Source: marketplace_provider_offerings_update_overview
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { marketplaceProviderOfferingsUpdateOverview } from 'waldur-js-client';

try {
  const response = await marketplaceProviderOfferingsUpdateOverview({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-marketplace-provider-offering"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
name string ✓
description string
full_description string
privacy_policy_link string (uri)
access_url string (uri) Publicly accessible offering access URL
getting_started string
integration_guide string
slug string URL-friendly identifier. Only editable by staff users.

200 - No response body

Update offering resource options

Updates the resource report form options for an offering.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/marketplace-provider-offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/update_resource_options/ \
  Authorization:"Token YOUR_API_TOKEN" \
  resource_options:='{}'

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.offering_resource_options_update_request import OfferingResourceOptionsUpdateRequest # (1)
from waldur_api_client.api.marketplace_provider_offerings import marketplace_provider_offerings_update_resource_options # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OfferingResourceOptionsUpdateRequest(
    resource_options={}
)
response = marketplace_provider_offerings_update_resource_options.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OfferingResourceOptionsUpdateRequest
  2. API Source: marketplace_provider_offerings_update_resource_options
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { marketplaceProviderOfferingsUpdateResourceOptions } from 'waldur-js-client';

try {
  const response = await marketplaceProviderOfferingsUpdateResourceOptions({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "resource_options": {}
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
resource_options object ✓
resource_options.order array of strings ✓
resource_options.options object (free-form) ✓

200 - No response body

Data & Reporting

Get statistics for offering components

Returns monthly usage statistics for the components of an offering within a specified date range.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-provider-offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/component_stats/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.offering_state import OfferingState # (1)
from waldur_api_client.models.provider_offering_details_o_enum import ProviderOfferingDetailsOEnum # (2)
from waldur_api_client.api.marketplace_provider_offerings import marketplace_provider_offerings_component_stats_list # (3)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_provider_offerings_component_stats_list.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

for item in response:
    print(item)
  1. Model Source: OfferingState
  2. Model Source: ProviderOfferingDetailsOEnum
  3. API Source: marketplace_provider_offerings_component_stats_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceProviderOfferingsComponentStatsList } from 'waldur-js-client';

try {
  const response = await marketplaceProviderOfferingsComponentStatsList({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type Description
accessible_via_calls boolean Accessible via calls
allowed_customer_uuid string (uuid) Allowed customer UUID
attributes string Offering attributes (JSON)
billable boolean Billable
can_create_offering_user boolean
category_group_uuid string (uuid) Category group UUID
category_uuid string (uuid) Category UUID
created string (date-time) Created after
customer string (uri) Customer URL
customer_uuid string (uuid) Customer UUID
description string Description contains
end string End date in format YYYY-MM.
has_active_terms_of_service boolean Has Active Terms of Service
has_terms_of_service boolean Has Terms of Service
importable string Filter by importable offerings.
keyword string Keyword
modified string (date-time) Modified after
name string Name
name_exact string Name (exact)
o array Ordering
organization_group_uuid string (uuid) Organization group UUID
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
parent_uuid string (uuid) Parent offering UUID
project_uuid string (uuid) Project UUID
query string Search by offering name, slug or description
resource_customer_uuid string (uuid) Resource customer UUID
resource_project_uuid string (uuid) Resource project UUID
scope_uuid string Scope UUID
service_manager_uuid string (uuid) Service manager UUID
shared boolean Shared
start string Start date in format YYYY-MM.
state array Offering state
tag array Tag UUID (OR logic)
tag_name array Tag name (OR logic)
tag_names_and string Tag names with AND logic (comma-separated)
tags_and string Tag UUIDs with AND logic (comma-separated)
type array Offering type
user_has_consent boolean User Has Consent
user_has_offering_user boolean User Has Offering User
uuid_list string Comma-separated offering UUIDs

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
period string
billing_period string
date string
usage integer
description string
measured_unit string
type string
name string

Get costs for an offering

Returns monthly cost data for an offering within a specified date range.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-provider-offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/costs/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.offering_state import OfferingState # (1)
from waldur_api_client.models.provider_offering_details_o_enum import ProviderOfferingDetailsOEnum # (2)
from waldur_api_client.api.marketplace_provider_offerings import marketplace_provider_offerings_costs_list # (3)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_provider_offerings_costs_list.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

for item in response:
    print(item)
  1. Model Source: OfferingState
  2. Model Source: ProviderOfferingDetailsOEnum
  3. API Source: marketplace_provider_offerings_costs_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceProviderOfferingsCostsList } from 'waldur-js-client';

try {
  const response = await marketplaceProviderOfferingsCostsList({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type Description
accessible_via_calls boolean Accessible via calls
accounting_is_running boolean
allowed_customer_uuid string (uuid) Allowed customer UUID
attributes string Offering attributes (JSON)
billable boolean Billable
can_create_offering_user boolean
category_group_uuid string (uuid) Category group UUID
category_uuid string (uuid) Category UUID
created string (date-time) Created after
customer string (uri) Customer URL
customer_uuid string (uuid) Customer UUID
description string Description contains
end string End date in format YYYY-MM.
has_active_terms_of_service boolean Has Active Terms of Service
has_terms_of_service boolean Has Terms of Service
importable string Filter by importable offerings.
keyword string Keyword
modified string (date-time) Modified after
name string Name
name_exact string Name (exact)
o array Ordering
organization_group_uuid string (uuid) Organization group UUID
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
parent_uuid string (uuid) Parent offering UUID
project_uuid string (uuid) Project UUID
query string Search by offering name, slug or description
resource_customer_uuid string (uuid) Resource customer UUID
resource_project_uuid string (uuid) Resource project UUID
scope_uuid string Scope UUID
service_manager_uuid string (uuid) Service manager UUID
shared boolean Shared
start string Start date in format YYYY-MM.
state array Offering state
tag array Tag UUID (OR logic)
tag_name array Tag name (OR logic)
tag_names_and string Tag names with AND logic (comma-separated)
tags_and string Tag UUIDs with AND logic (comma-separated)
type array Offering type
user_has_consent boolean User Has Consent
user_has_offering_user boolean User Has Offering User
uuid_list string Comma-separated offering UUIDs

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
period string Billing period (YYYY-MM)
price number (double) Price amount excluding tax
tax number (double) Tax amount
total number (double) Total amount including tax

Get customers for an offering

Returns a paginated list of customers who have resources for this offering.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-provider-offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/customers/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.offering_state import OfferingState # (1)
from waldur_api_client.models.provider_offering_customer_field_enum import ProviderOfferingCustomerFieldEnum # (2)
from waldur_api_client.models.provider_offering_details_o_enum import ProviderOfferingDetailsOEnum # (3)
from waldur_api_client.api.marketplace_provider_offerings import marketplace_provider_offerings_customers_list # (4)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_provider_offerings_customers_list.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

for item in response:
    print(item)
  1. Model Source: OfferingState
  2. Model Source: ProviderOfferingCustomerFieldEnum
  3. Model Source: ProviderOfferingDetailsOEnum
  4. API Source: marketplace_provider_offerings_customers_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceProviderOfferingsCustomersList } from 'waldur-js-client';

try {
  const response = await marketplaceProviderOfferingsCustomersList({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type Description
accessible_via_calls boolean Accessible via calls
allowed_customer_uuid string (uuid) Allowed customer UUID
attributes string Offering attributes (JSON)
billable boolean Billable
can_create_offering_user boolean
category_group_uuid string (uuid) Category group UUID
category_uuid string (uuid) Category UUID
created string (date-time) Created after
customer string (uri) Customer URL
customer_uuid string (uuid) Customer UUID
description string Description contains
field array
has_active_terms_of_service boolean Has Active Terms of Service
has_terms_of_service boolean Has Terms of Service
importable string Filter by importable offerings.
keyword string Keyword
modified string (date-time) Modified after
name string Name
name_exact string Name (exact)
o array Ordering
organization_group_uuid string (uuid) Organization group UUID
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
parent_uuid string (uuid) Parent offering UUID
project_uuid string (uuid) Project UUID
query string Search by offering name, slug or description
resource_customer_uuid string (uuid) Resource customer UUID
resource_project_uuid string (uuid) Resource project UUID
scope_uuid string Scope UUID
service_manager_uuid string (uuid) Service manager UUID
shared boolean Shared
state array Offering state
tag array Tag UUID (OR logic)
tag_name array Tag name (OR logic)
tag_names_and string Tag names with AND logic (comma-separated)
tags_and string Tag UUIDs with AND logic (comma-separated)
type array Offering type
user_has_consent boolean User Has Consent
user_has_offering_user boolean User Has Offering User
uuid_list string Comma-separated offering UUIDs

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
uuid string (uuid)
name string
slug string
abbreviation string
phone_number string
email string (email)

List offerings grouped by provider

Returns a paginated list of active, shared offerings grouped by their service provider.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-provider-offerings/groups/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.offering_state import OfferingState # (1)
from waldur_api_client.models.provider_offering_details_o_enum import ProviderOfferingDetailsOEnum # (2)
from waldur_api_client.api.marketplace_provider_offerings import marketplace_provider_offerings_groups_list # (3)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_provider_offerings_groups_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: OfferingState
  2. Model Source: ProviderOfferingDetailsOEnum
  3. API Source: marketplace_provider_offerings_groups_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceProviderOfferingsGroupsList } from 'waldur-js-client';

try {
  const response = await marketplaceProviderOfferingsGroupsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
accessible_via_calls boolean Accessible via calls
allowed_customer_uuid string (uuid) Allowed customer UUID
attributes string Offering attributes (JSON)
billable boolean Billable
can_create_offering_user boolean
category_group_uuid string (uuid) Category group UUID
category_uuid string (uuid) Category UUID
created string (date-time) Created after
customer string (uri) Customer URL
customer_uuid string (uuid) Customer UUID
description string Description contains
has_active_terms_of_service boolean Has Active Terms of Service
has_terms_of_service boolean Has Terms of Service
keyword string Keyword
modified string (date-time) Modified after
name string Name
name_exact string Name (exact)
o array Ordering
organization_group_uuid string (uuid) Organization group UUID
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
parent_uuid string (uuid) Parent offering UUID
project_uuid string (uuid) Project UUID
query string Search by offering name, slug or description
resource_customer_uuid string (uuid) Resource customer UUID
resource_project_uuid string (uuid) Resource project UUID
scope_uuid string Scope UUID
service_manager_uuid string (uuid) Service manager UUID
shared boolean Shared
state array Offering state
tag array Tag UUID (OR logic)
tag_name array Tag name (OR logic)
tag_names_and string Tag names with AND logic (comma-separated)
tags_and string Tag UUIDs with AND logic (comma-separated)
type array Offering type
user_has_consent boolean User Has Consent
user_has_offering_user boolean User Has Offering User
uuid_list string Comma-separated offering UUIDs

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
customer_name string
customer_uuid string
offerings array of objects
offerings.offering_name string Name of the offering
offerings.offering_uuid string (uuid) UUID of the offering

List customer projects for an offering

Returns a paginated list of projects that have consumed resources of this offering.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-provider-offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/list_customer_projects/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.project_field_enum import ProjectFieldEnum # (1)
from waldur_api_client.api.marketplace_provider_offerings import marketplace_provider_offerings_list_customer_projects_list # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_provider_offerings_list_customer_projects_list.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

for item in response:
    print(item)
  1. Model Source: ProjectFieldEnum
  2. API Source: marketplace_provider_offerings_list_customer_projects_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceProviderOfferingsListCustomerProjectsList } from 'waldur-js-client';

try {
  const response = await marketplaceProviderOfferingsListCustomerProjectsList({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type Description
field array
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
name string
slug string URL-friendly identifier. Only editable by staff users.
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_slug string
customer_native_name string
customer_abbreviation string
description string Project description (HTML content will be sanitized)
customer_display_billing_info_in_projects boolean
created string (date-time)
type string (uri)
type_name string
type_uuid string (uuid)
backend_id string
start_date string (date) Project start date. Cannot be edited after the start date has arrived.
end_date string (date) Project end date. Setting this field requires DELETE_PROJECT permission.
end_date_requested_by string (uri)
oecd_fos_2007_code any
oecd_fos_2007_label string Human-readable label for the OECD FOS 2007 classification code
is_industry boolean
image string (uri)
resources_count integer Number of active resources in this project
max_service_accounts integer Maximum number of service accounts allowed
kind any
is_removed boolean
termination_metadata any Metadata about project termination (read-only)
staff_notes string Internal notes visible only to staff and support users (HTML content will be sanitized)
grace_period_days integer Number of extra days after project end date before resources are terminated. Overrides customer-level setting.
user_email_patterns any
user_affiliations any
user_identity_sources any List of allowed identity sources (identity providers).
project_credit number (double)
marketplace_resource_count object (free-form)
billing_price_estimate any

List orders for an offering

Returns a paginated list of orders associated with a specific offering.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-provider-offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/orders/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.order_details_field_enum import OrderDetailsFieldEnum # (1)
from waldur_api_client.api.marketplace_provider_offerings import marketplace_provider_offerings_orders_list # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_provider_offerings_orders_list.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

for item in response:
    print(item)
  1. Model Source: OrderDetailsFieldEnum
  2. API Source: marketplace_provider_offerings_orders_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceProviderOfferingsOrdersList } from 'waldur-js-client';

try {
  const response = await marketplaceProviderOfferingsOrdersList({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type Description
field array
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
offering string (uri)
offering_name string
offering_uuid string (uuid)
offering_description string
offering_image string (uri)
offering_thumbnail string (uri)
offering_type string
offering_shared boolean Accessible to all customers.
offering_billable boolean Purchase and usage is invoiced.
offering_plugin_options any Public data used by specific plugin, such as storage mode for OpenStack.
provider_name string
provider_uuid string (uuid)
provider_slug string
category_title string
category_uuid string (uuid)
category_icon string (uri)
plan string (uri)
plan_unit any
plan_name string
plan_uuid string (uuid)
plan_description string
attributes any
limits object (free-form)
uuid string (uuid)
created string (date-time)
modified string (date-time)
resource_uuid string (uuid)
resource_type string
resource_name string
cost string (decimal)
state any
output string
marketplace_resource_uuid string (uuid)
error_message string
error_traceback string
callback_url string (uri)
completed_at string (date-time)
request_comment string
attachment string (uri)
type any
start_date string (date) Enables delayed processing of resource provisioning order.
slug string
url string (uri)
consumer_reviewed_by string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
consumer_reviewed_by_full_name string
consumer_reviewed_by_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
consumer_reviewed_at string (date-time)
provider_reviewed_by string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
provider_reviewed_by_full_name string
provider_reviewed_by_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
provider_reviewed_at string (date-time)
created_by_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
created_by_full_name string
created_by_civil_number string
created_by_email string (email)
created_by_organization string
created_by_organization_registry_code string Company registration code of the user's organization, if known
customer_name string
customer_uuid string (uuid)
customer_slug string
project_name string
project_uuid string (uuid)
project_description string
project_slug string
old_plan_name string
new_plan_name string
old_plan_uuid string (uuid)
new_plan_uuid string (uuid)
old_cost_estimate number (double)
new_cost_estimate string (decimal)
can_terminate boolean
fixed_price number (double)
activation_price number (double)
termination_comment string
backend_id string
order_subtype string
provider_message string
provider_message_url string (uri)
provider_message_attachment string (uri)
consumer_message string
consumer_message_attachment string (uri)
consumer_rejection_comment string
provider_rejection_comment string
issue any

Retrieve a specific order for an offering

Returns details of a specific order associated with an offering.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-provider-offerings/string-value/orders/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_provider_offerings import marketplace_provider_offerings_orders_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_provider_offerings_orders_retrieve.sync(
    order_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    uuid="string-value",
    client=client
)

print(response)
  1. API Source: marketplace_provider_offerings_orders_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { marketplaceProviderOfferingsOrdersRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceProviderOfferingsOrdersRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "order_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "uuid": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
order_uuid string ✓
uuid string ✓

200 -

Field Type Description
offering string (uri)
offering_name string
offering_uuid string (uuid)
offering_description string
offering_image string (uri)
offering_thumbnail string (uri)
offering_type string
offering_shared boolean Accessible to all customers.
offering_billable boolean Purchase and usage is invoiced.
offering_plugin_options any Public data used by specific plugin, such as storage mode for OpenStack.
provider_name string
provider_uuid string (uuid)
provider_slug string
category_title string
category_uuid string (uuid)
category_icon string (uri)
plan string (uri)
plan_unit any
plan_name string
plan_uuid string (uuid)
plan_description string
attributes any
limits object (free-form)
uuid string (uuid)
created string (date-time)
modified string (date-time)
resource_uuid string (uuid)
resource_type string
resource_name string
cost string (decimal)
state any
output string
marketplace_resource_uuid string (uuid)
error_message string
error_traceback string
callback_url string (uri)
completed_at string (date-time)
request_comment string
attachment string (uri)
type any
start_date string (date) Enables delayed processing of resource provisioning order.
slug string
url string (uri)
consumer_reviewed_by string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
consumer_reviewed_by_full_name string
consumer_reviewed_by_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
consumer_reviewed_at string (date-time)
provider_reviewed_by string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
provider_reviewed_by_full_name string
provider_reviewed_by_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
provider_reviewed_at string (date-time)
created_by_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
created_by_full_name string
created_by_civil_number string
created_by_email string (email)
created_by_organization string
created_by_organization_registry_code string Company registration code of the user's organization, if known
customer_name string
customer_uuid string (uuid)
customer_slug string
project_name string
project_uuid string (uuid)
project_description string
project_slug string
old_plan_name string
new_plan_name string
old_plan_uuid string (uuid)
new_plan_uuid string (uuid)
old_cost_estimate number (double)
new_cost_estimate string (decimal)
can_terminate boolean
fixed_price number (double)
activation_price number (double)
termination_comment string
backend_id string
order_subtype string
provider_message string
provider_message_url string (uri)
provider_message_attachment string (uri)
consumer_message string
consumer_message_attachment string (uri)
consumer_rejection_comment string
provider_rejection_comment string
issue any

Get offering statistics

Returns basic statistics for an offering, such as the number of active resources and customers.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-provider-offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/stats/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_provider_offerings import marketplace_provider_offerings_stats_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_provider_offerings_stats_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_provider_offerings_stats_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceProviderOfferingsStatsRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceProviderOfferingsStatsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
resources_count integer
customers_count integer

Returns comprehensive Terms of Service consent statistics for this offering, including user counts, consent rates, and historical data.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-provider-offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/tos_stats/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_provider_offerings import marketplace_provider_offerings_tos_stats_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_provider_offerings_tos_stats_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_provider_offerings_tos_stats_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceProviderOfferingsTosStatsRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceProviderOfferingsTosStatsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
active_users_count integer Number of active users
total_users_count integer Total number of users
active_users_percentage number (double) Percentage of active users
accepted_consents_count integer Number of accepted consents
revoked_consents_count integer Number of revoked consents
total_consents_count integer Total number of consents
revoked_consents_over_time array of objects
revoked_consents_over_time.date string (date) Date of the data point
revoked_consents_over_time.count integer Count for the date
tos_version_adoption array of objects
tos_version_adoption.version string Version identifier
tos_version_adoption.users_count integer Number of users on this version
active_users_over_time array of objects
active_users_over_time.date string (date) Date of the data point
active_users_over_time.count integer Count for the date
accepted_consents_over_time array of objects
accepted_consents_over_time.date string (date) Date of the data point
accepted_consents_over_time.count integer Count for the date

Remote Actions & Sync

List importable resources

Returns a paginated list of resources that can be imported for this offering.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-provider-offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/importable_resources/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_provider_offerings import marketplace_provider_offerings_importable_resources_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_provider_offerings_importable_resources_list.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

for item in response:
    print(item)
  1. API Source: marketplace_provider_offerings_importable_resources_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceProviderOfferingsImportableResourcesList } from 'waldur-js-client';

try {
  const response = await marketplaceProviderOfferingsImportableResourcesList({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
backend_id string Backend identifier of the resource
name string Name of the resource
type string Type of the resource
description string Description of the resource

Import a resource

Imports a backend resource into the marketplace.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/marketplace-provider-offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/import_resource/ \
  Authorization:"Token YOUR_API_TOKEN" \
  backend_id="ext-a1b2c3d4" \
  project="a1b2c3d4-e5f6-7890-abcd-ef1234567890"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.import_resource_request import ImportResourceRequest # (1)
from waldur_api_client.api.marketplace_provider_offerings import marketplace_provider_offerings_import_resource # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ImportResourceRequest(
    backend_id="ext-a1b2c3d4",
    project="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
)
response = marketplace_provider_offerings_import_resource.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ImportResourceRequest
  2. API Source: marketplace_provider_offerings_import_resource
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { marketplaceProviderOfferingsImportResource } from 'waldur-js-client';

try {
  const response = await marketplaceProviderOfferingsImportResource({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "backend_id": "ext-a1b2c3d4",
    "project": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
backend_id string ✓ Backend identifier of the resource
project string (uuid) ✓ Target project for the resource
plan string (uuid)
additional_details any
Constraints: write-only, default: {}

200 -

Field Type Description
offering string (uri)
offering_name string
offering_uuid string (uuid)
offering_description string
offering_image string (uri)
offering_thumbnail string (uri)
offering_type string
offering_shared boolean Accessible to all customers.
offering_billable boolean Purchase and usage is invoiced.
offering_plugin_options any Public data used by specific plugin, such as storage mode for OpenStack.
provider_name string
provider_uuid string (uuid)
provider_slug string
category_title string
category_uuid string (uuid)
category_icon string (uri)
plan string (uri)
plan_unit any
plan_name string
plan_uuid string (uuid)
plan_description string
attributes object (free-form)
limits object (free-form)
uuid string (uuid)
created string (date-time)
modified string (date-time)
url string (uri)
scope string
description string
state any
resource_uuid string (uuid)
backend_id string
effective_id string
resource_type string
project string (uri)
project_uuid string (uuid)
project_name string
project_description string
project_end_date string (date) The date is inclusive. Once reached, all project resource will be scheduled for termination.
project_end_date_requested_by string (uri)
customer_uuid string (uuid)
customer_name string
offering_slug string
parent_offering_uuid string (uuid)
parent_offering_name string
parent_offering_slug string
offering_backend_id string
parent_uuid string (uuid)
parent_name string
backend_metadata any
is_usage_based boolean Returns True if the resource has usage-based components that track variable consumption.
is_limit_based boolean Returns True if the resource has limit-based components with user-adjustable quotas.
name string
slug string URL-friendly identifier. Only editable by staff users.
current_usages object (free-form) Dictionary mapping component types to their latest reported usage amounts.
can_terminate boolean
report array of objects
report.header string Section header text
report.body string Section body content
end_date string (date) The date is inclusive. Once reached, a resource will be scheduled for termination.
end_date_requested_by string (uri)
username string
limit_usage object (free-form) Dictionary mapping limit-based component types to their consumed usage. For monthly periods, maps from current_usages; for longer periods, aggregates historical usage.
downscaled boolean
restrict_member_access boolean
paused boolean
endpoints array of objects
endpoints.uuid string (uuid)
endpoints.name string
endpoints.url string URL of the access endpoint
error_message string
error_traceback string
options any
available_actions array of strings
last_sync string (date-time)
order_in_progress any
creation_order any
service_settings_uuid string (uuid)
project_slug string
customer_slug string
user_requires_reconsent boolean Check if the current user needs to re-consent for this resource's offering.
renewal_date object (free-form)
offering_state any
offering_components array of objects
offering_components.uuid string (uuid)
offering_components.billing_type string
Enum: fixed, usage, limit, one, few
offering_components.type string Unique internal name of the measured unit, for example floating_ip.
offering_components.name string Display name for the measured unit, for example, Floating IP.
offering_components.description string
offering_components.measured_unit string Unit of measurement, for example, GB.
offering_components.unit_factor integer The conversion factor from backend units to measured_unit
offering_components.limit_period any
offering_components.limit_amount integer
offering_components.article_code string
offering_components.max_value integer
offering_components.min_value integer
offering_components.max_available_limit integer
offering_components.is_boolean boolean
offering_components.default_limit integer
offering_components.factor integer
offering_components.is_builtin boolean
offering_components.is_prepaid boolean
offering_components.overage_component string (uuid)
offering_components.min_prepaid_duration integer
offering_components.max_prepaid_duration integer

Synchronize offering service settings

Schedules a synchronization task to pull the latest data for the offering's service settings from the backend.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-provider-offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/sync/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_provider_offerings import marketplace_provider_offerings_sync # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_provider_offerings_sync.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_provider_offerings_sync
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceProviderOfferingsSync } from 'waldur-js-client';

try {
  const response = await marketplaceProviderOfferingsSync({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

202 - No response body

Other Actions

Get object state at a specific timestamp

Returns the state of the object as it was at the specified timestamp. Only accessible by staff and support users.

1
2
3
4
5
http \
  GET \
  https://api.example.com/api/marketplace-provider-offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/history/at/ \
  Authorization:"Token YOUR_API_TOKEN" \
  timestamp=="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_provider_offerings import marketplace_provider_offerings_history_at_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_provider_offerings_history_at_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    timestamp="string-value"
)

print(response)
  1. API Source: marketplace_provider_offerings_history_at_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { marketplaceProviderOfferingsHistoryAtRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceProviderOfferingsHistoryAtRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  query: {
    "timestamp": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type Required Description
timestamp string ✓ ISO 8601 timestamp to query the object state at

200 -

Field Type Description
id integer Version ID
revision_date string (date-time) When this revision was created
revision_user object (free-form) User who created this revision
revision_comment string Comment describing the revision
serialized_data object (free-form) Serialized model fields at this revision

400 -

404 -

Get version history

Returns the version history for this object. Only accessible by staff and support users.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-provider-offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/history/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.offering_state import OfferingState # (1)
from waldur_api_client.models.provider_offering_details_o_enum import ProviderOfferingDetailsOEnum # (2)
from waldur_api_client.api.marketplace_provider_offerings import marketplace_provider_offerings_history_list # (3)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_provider_offerings_history_list.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

for item in response:
    print(item)
  1. Model Source: OfferingState
  2. Model Source: ProviderOfferingDetailsOEnum
  3. API Source: marketplace_provider_offerings_history_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceProviderOfferingsHistoryList } from 'waldur-js-client';

try {
  const response = await marketplaceProviderOfferingsHistoryList({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type Description
accessible_via_calls boolean Accessible via calls
allowed_customer_uuid string (uuid) Allowed customer UUID
attributes string Offering attributes (JSON)
billable boolean Billable
can_create_offering_user boolean
category_group_uuid string (uuid) Category group UUID
category_uuid string (uuid) Category UUID
created string (date-time) Created after
created_after string Filter versions created after this timestamp (ISO 8601)
created_before string Filter versions created before this timestamp (ISO 8601)
customer string (uri) Customer URL
customer_uuid string (uuid) Customer UUID
description string Description contains
has_active_terms_of_service boolean Has Active Terms of Service
has_terms_of_service boolean Has Terms of Service
importable string Filter by importable offerings.
keyword string Keyword
modified string (date-time) Modified after
name string Name
name_exact string Name (exact)
o array Ordering
organization_group_uuid string (uuid) Organization group UUID
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
parent_uuid string (uuid) Parent offering UUID
project_uuid string (uuid) Project UUID
query string Search by offering name, slug or description
resource_customer_uuid string (uuid) Resource customer UUID
resource_project_uuid string (uuid) Resource project UUID
scope_uuid string Scope UUID
service_manager_uuid string (uuid) Service manager UUID
shared boolean Shared
state array Offering state
tag array Tag UUID (OR logic)
tag_name array Tag name (OR logic)
tag_names_and string Tag names with AND logic (comma-separated)
tags_and string Tag UUIDs with AND logic (comma-separated)
type array Offering type
user_has_consent boolean User Has Consent
user_has_offering_user boolean User Has Offering User
uuid_list string Comma-separated offering UUIDs

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
id integer Version ID
revision_date string (date-time) When this revision was created
revision_user object (free-form) User who created this revision
revision_comment string Comment describing the revision
serialized_data object (free-form) Serialized model fields at this revision

Get user attribute config

Returns the user attribute configuration for this offering, which determines which user attributes are exposed to the service provider.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-provider-offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/user-attribute-config/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_provider_offerings import marketplace_provider_offerings_user_attribute_config_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_provider_offerings_user_attribute_config_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_provider_offerings_user_attribute_config_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceProviderOfferingsUserAttributeConfigRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceProviderOfferingsUserAttributeConfigRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
uuid string (uuid)
created string (date-time)
modified string (date-time)
offering_uuid string (uuid)
offering_name string
expose_username boolean
expose_full_name boolean
expose_email boolean
expose_phone_number boolean
expose_organization boolean
expose_job_title boolean
expose_affiliations boolean
expose_gender boolean
expose_personal_title boolean
expose_place_of_birth boolean
expose_country_of_residence boolean
expose_nationality boolean
expose_nationalities boolean
expose_organization_country boolean
expose_organization_type boolean
expose_organization_registry_code boolean
expose_eduperson_assurance boolean
expose_civil_number boolean
expose_birth_date boolean
expose_identity_source boolean
expose_active_isds boolean
exposed_fields array of strings Return list of field names currently configured for exposure.
is_default boolean Return True if this is a default (unsaved) config.

Check if backend_id is unique

Checks if the provided backend_id has been used in resources of this offering or all offerings of the same customer. Returns true if unique, false if already used.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/marketplace-provider-offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/check_unique_backend_id/ \
  Authorization:"Token YOUR_API_TOKEN" \
  backend_id="ext-a1b2c3d4"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.check_unique_backend_id_request import CheckUniqueBackendIDRequest # (1)
from waldur_api_client.api.marketplace_provider_offerings import marketplace_provider_offerings_check_unique_backend_id # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = CheckUniqueBackendIDRequest(
    backend_id="ext-a1b2c3d4"
)
response = marketplace_provider_offerings_check_unique_backend_id.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: CheckUniqueBackendIDRequest
  2. API Source: marketplace_provider_offerings_check_unique_backend_id
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { marketplaceProviderOfferingsCheckUniqueBackendId } from 'waldur-js-client';

try {
  const response = await marketplaceProviderOfferingsCheckUniqueBackendId({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "backend_id": "ext-a1b2c3d4"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
backend_id string ✓ Backend identifier to check
check_all_offerings boolean Check across all offerings
Constraints: default: False
use_offering_rules boolean Apply the offering's backend_id_rules for format and uniqueness validation
Constraints: default: False

200 -

Field Type Description
is_unique boolean Whether the backend ID is unique
is_valid_format boolean Whether the backend ID matches the offering's format regex (null if no rules configured)
errors array of strings List of validation error messages

Delete tags for offering

Removes all tag associations from this offering.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-provider-offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/delete_tags/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_provider_offerings import marketplace_provider_offerings_delete_tags # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_provider_offerings_delete_tags.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_provider_offerings_delete_tags
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceProviderOfferingsDeleteTags } from 'waldur-js-client';

try {
  const response = await marketplaceProviderOfferingsDeleteTags({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Export offering data

Exports an offering and all its connected parts to YAML format. Allows configuration of which components to include in the export.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-provider-offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/export_offering/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.offering_export_parameters_request import OfferingExportParametersRequest # (1)
from waldur_api_client.api.marketplace_provider_offerings import marketplace_provider_offerings_export_offering # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OfferingExportParametersRequest()
response = marketplace_provider_offerings_export_offering.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OfferingExportParametersRequest
  2. API Source: marketplace_provider_offerings_export_offering
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceProviderOfferingsExportOffering } from 'waldur-js-client';

try {
  const response = await marketplaceProviderOfferingsExportOffering({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
include_components boolean Include offering components in export
Constraints: default: True
include_plans boolean Include offering plans in export
Constraints: default: True
include_screenshots boolean Include offering screenshots in export
Constraints: default: True
include_files boolean Include offering files in export
Constraints: default: True
include_endpoints boolean Include offering access endpoints in export
Constraints: default: True
include_organization_groups boolean Include organization groups associations in export
Constraints: default: True
include_terms_of_service boolean Include terms of service configurations in export
Constraints: default: True
include_plugin_options boolean Include plugin options in export
Constraints: default: True
include_secret_options boolean Include secret options in export (WARNING: sensitive data)
Constraints: default: False
include_attributes boolean Include offering attributes in export
Constraints: default: True
include_options boolean Include offering options in export
Constraints: default: True
include_resource_options boolean Include resource options in export
Constraints: default: True

200 -

Field Type Description
offering_uuid string (uuid) UUID of the exported offering
offering_name string Name of the exported offering
export_data any Complete export data containing the offering structure
exported_components array of strings List of exported component types
export_timestamp string (date-time) Timestamp when the export was completed

Import offering data

Imports an offering and all its connected parts from YAML format. Allows configuration of which components to import and how to handle conflicts. Imported offerings are always created in DRAFT state for security.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/marketplace-provider-offerings/import_offering/ \
  Authorization:"Token YOUR_API_TOKEN" \
  offering_data=null

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.offering_import_parameters_request import OfferingImportParametersRequest # (1)
from waldur_api_client.api.marketplace_provider_offerings import marketplace_provider_offerings_import_offering # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OfferingImportParametersRequest(
    offering_data=null
)
response = marketplace_provider_offerings_import_offering.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OfferingImportParametersRequest
  2. API Source: marketplace_provider_offerings_import_offering
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceProviderOfferingsImportOffering } from 'waldur-js-client';

try {
  const response = await marketplaceProviderOfferingsImportOffering({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "offering_data": null
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
customer string (uuid) Target customer for imported offering. If not provided, uses current user's customer
category string Target category name for imported offering. If not provided, uses category from export data
project string (uuid) Target project for imported offering (optional)
import_components boolean Import offering components
Constraints: default: True
import_plans boolean Import offering plans
Constraints: default: True
import_screenshots boolean Import offering screenshots
Constraints: default: True
import_files boolean Import offering files
Constraints: default: True
import_endpoints boolean Import offering access endpoints
Constraints: default: True
import_organization_groups boolean Import organization groups associations (may fail if groups don't exist)
Constraints: default: False
import_terms_of_service boolean Import terms of service configurations
Constraints: default: True
import_plugin_options boolean Import plugin options
Constraints: default: True
import_secret_options boolean Import secret options (WARNING: will overwrite existing secrets)
Constraints: default: False
overwrite_existing boolean Overwrite existing offering if one with the same name exists
Constraints: default: False
offering_data any ✓ The exported offering data to import

200 -

Field Type Description
imported_offering_uuid string (uuid) UUID of the imported offering
imported_offering_name string Name of the imported offering
imported_components array of strings List of imported component types
warnings array of strings List of warnings encountered during import
import_timestamp string (date-time) Timestamp when the import was completed

Mark an offering as available

Marks an unavailable offering as available.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-provider-offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/make_available/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_provider_offerings import marketplace_provider_offerings_make_available # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_provider_offerings_make_available.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_provider_offerings_make_available
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceProviderOfferingsMakeAvailable } from 'waldur-js-client';

try {
  const response = await marketplaceProviderOfferingsMakeAvailable({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
detail string
state string

Mark an offering as unavailable

Marks an active offering as unavailable, blocking all operations on its resources.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-provider-offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/make_unavailable/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_provider_offerings import marketplace_provider_offerings_make_unavailable # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_provider_offerings_make_unavailable.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_provider_offerings_make_unavailable
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceProviderOfferingsMakeUnavailable } from 'waldur-js-client';

try {
  const response = await marketplaceProviderOfferingsMakeUnavailable({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
detail string
state string

Update offering backend_id rules

Configure validation rules for resource backend_id: format regex and uniqueness scope.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-provider-offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/update_backend_id_rules/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.offering_backend_id_rules_update_request import OfferingBackendIdRulesUpdateRequest # (1)
from waldur_api_client.api.marketplace_provider_offerings import marketplace_provider_offerings_update_backend_id_rules # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OfferingBackendIdRulesUpdateRequest()
response = marketplace_provider_offerings_update_backend_id_rules.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OfferingBackendIdRulesUpdateRequest
  2. API Source: marketplace_provider_offerings_update_backend_id_rules
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceProviderOfferingsUpdateBackendIdRules } from 'waldur-js-client';

try {
  const response = await marketplaceProviderOfferingsUpdateBackendIdRules({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
backend_id_rules any Validation rules for resource backend_id: format regex and uniqueness scope.

200 - No response body

Update tags for offering

Sets the list of tags for this offering.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-provider-offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/update_tags/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.tags_request import TagsRequest # (1)
from waldur_api_client.api.marketplace_provider_offerings import marketplace_provider_offerings_update_tags # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = TagsRequest()
response = marketplace_provider_offerings_update_tags.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: TagsRequest
  2. API Source: marketplace_provider_offerings_update_tags
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceProviderOfferingsUpdateTags } from 'waldur-js-client';

try {
  const response = await marketplaceProviderOfferingsUpdateTags({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
tags array of string (uuid)s

200 - No response body

Marketplace Provider Resources

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/marketplace-provider-resources/ List provider resources
GET /api/marketplace-provider-resources/{uuid}/ Retrieve a provider resource
POST /api/marketplace-provider-resources/{uuid}/pull/ Pull resource data
POST /api/marketplace-provider-resources/{uuid}/unlink/ Unlink a resource (staff only)
POST /api/marketplace-provider-resources/{uuid}/update_options/ Update resource options
POST /api/marketplace-provider-resources/{uuid}/update_options_direct/ Update resource options directly
PUT /api/marketplace-provider-resources/{uuid}/ Update a provider resource
PATCH /api/marketplace-provider-resources/{uuid}/ Partially update a provider resource
Other Actions
GET /api/marketplace-provider-resources/{uuid}/details/ Get resource details
GET /api/marketplace-provider-resources/{uuid}/glauth_users_config/ Get GLauth user configuration for a resource
GET /api/marketplace-provider-resources/{uuid}/history/at/ Get object state at a specific timestamp
GET /api/marketplace-provider-resources/{uuid}/history/ Get version history
GET /api/marketplace-provider-resources/{uuid}/offering_for_subresources/ List offerings for sub-resources
GET /api/marketplace-provider-resources/{uuid}/offering/ Get offering details
GET /api/marketplace-provider-resources/{uuid}/plan_periods/ List resource plan periods
GET /api/marketplace-provider-resources/{uuid}/team/ Get resource team
POST /api/marketplace-provider-resources/{uuid}/move_resource/ Move a resource to another project
POST /api/marketplace-provider-resources/{uuid}/refresh_last_sync/ Refresh last sync time
POST /api/marketplace-provider-resources/{uuid}/restore/ Restore
POST /api/marketplace-provider-resources/{uuid}/set_as_erred/ Set resource state to erred
POST /api/marketplace-provider-resources/{uuid}/set_as_ok/ Set resource state to OK
POST /api/marketplace-provider-resources/{uuid}/set_backend_id/ Set resource backend ID
POST /api/marketplace-provider-resources/{uuid}/set_backend_metadata/ Set resource backend metadata
POST /api/marketplace-provider-resources/{uuid}/set_downscaled/ Set downscaled flag for resource
POST /api/marketplace-provider-resources/{uuid}/set_end_date_by_provider/ Set end date by provider
POST /api/marketplace-provider-resources/{uuid}/set_end_date_by_staff/ Set end date of the resource by staff
POST /api/marketplace-provider-resources/{uuid}/set_keycloak_scopes/ Set Keycloak scope options for a resource
POST /api/marketplace-provider-resources/{uuid}/set_limits/ Set resource limits
POST /api/marketplace-provider-resources/{uuid}/set_paused/ Set paused flag for resource
POST /api/marketplace-provider-resources/{uuid}/set_restrict_member_access/ Set restrict member access flag
POST /api/marketplace-provider-resources/{uuid}/set_slug/ Set resource slug
POST /api/marketplace-provider-resources/{uuid}/set_state_ok/ Set resource state to OK
POST /api/marketplace-provider-resources/{uuid}/submit_report/ Submit a report for a resource
POST /api/marketplace-provider-resources/{uuid}/terminate/ Terminate a resource

Core CRUD

List provider resources

Returns a paginated list of resources for offerings managed by the current user as a service provider.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-provider-resources/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.order_state import OrderState # (1)
from waldur_api_client.models.resource_field_enum import ResourceFieldEnum # (2)
from waldur_api_client.models.resource_o_enum import ResourceOEnum # (3)
from waldur_api_client.models.resource_state import ResourceState # (4)
from waldur_api_client.api.marketplace_provider_resources import marketplace_provider_resources_list # (5)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_provider_resources_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: OrderState
  2. Model Source: ResourceFieldEnum
  3. Model Source: ResourceOEnum
  4. Model Source: ResourceState
  5. API Source: marketplace_provider_resources_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceProviderResourcesList } from 'waldur-js-client';

try {
  const response = await marketplaceProviderResourcesList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
backend_id string Backend ID
category_uuid string (uuid) Category UUID
component_count number Filter by exact number of components
created string (date-time) Created after
customer string (uri) Customer URL
customer_uuid string (uuid) Customer UUID
downscaled boolean Downscaled
field array
has_terminate_date boolean Has termination date
is_attached boolean Filter by attached state
lexis_links_supported boolean LEXIS links supported
limit_based boolean Filter by limit-based offerings
limit_component_count number Filter by exact number of limit-based components
modified string (date-time) Modified after
name string Name
name_exact string Name (exact)
o array Ordering
offering string (uri)
offering_billable boolean Offering billable
offering_shared boolean Offering shared
offering_slug array Multiple values may be separated by commas.
offering_type string Offering type
offering_uuid array Multiple values may be separated by commas.
only_limit_based boolean Filter resources with only limit-based components
only_usage_based boolean Filter resources with only usage-based components
order_state array Order state
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
parent_offering_uuid string (uuid)
paused boolean Paused
plan_uuid string (uuid) Plan UUID
project_name string Project name
project_uuid string (uuid) Project UUID
provider_uuid string (uuid) Provider UUID
query string Search by resource UUID, name, slug, backend ID, effective ID, IPs or hypervisor
restrict_member_access boolean Restrict member access
runtime_state string Runtime state
scope string (uri) Filter by scope URL.
service_manager_uuid string (uuid) Service manager UUID
state array Resource state
usage_based boolean Filter by usage-based offerings
visible_to_providers boolean Include only resources visible to service providers
visible_to_username string Visible to username

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
offering string (uri)
offering_name string
offering_uuid string (uuid)
offering_description string
offering_image string (uri)
offering_thumbnail string (uri)
offering_type string
offering_shared boolean Accessible to all customers.
offering_billable boolean Purchase and usage is invoiced.
offering_plugin_options any Public data used by specific plugin, such as storage mode for OpenStack.
provider_name string
provider_uuid string (uuid)
provider_slug string
category_title string
category_uuid string (uuid)
category_icon string (uri)
plan string (uri)
plan_unit any
plan_name string
plan_uuid string (uuid)
plan_description string
attributes object (free-form)
limits object (free-form)
uuid string (uuid)
created string (date-time)
modified string (date-time)
url string (uri)
scope string
description string
state any
resource_uuid string (uuid)
backend_id string
effective_id string
resource_type string
project string (uri)
project_uuid string (uuid)
project_name string
project_description string
project_end_date string (date) The date is inclusive. Once reached, all project resource will be scheduled for termination.
project_end_date_requested_by string (uri)
customer_uuid string (uuid)
customer_name string
offering_slug string
parent_offering_uuid string (uuid)
parent_offering_name string
parent_offering_slug string
offering_backend_id string
parent_uuid string (uuid)
parent_name string
backend_metadata any
is_usage_based boolean Returns True if the resource has usage-based components that track variable consumption.
is_limit_based boolean Returns True if the resource has limit-based components with user-adjustable quotas.
name string
slug string URL-friendly identifier. Only editable by staff users.
current_usages object (free-form) Dictionary mapping component types to their latest reported usage amounts.
can_terminate boolean
report array of objects
report.header string Section header text
report.body string Section body content
end_date string (date) The date is inclusive. Once reached, a resource will be scheduled for termination.
end_date_requested_by string (uri)
username string
limit_usage object (free-form) Dictionary mapping limit-based component types to their consumed usage. For monthly periods, maps from current_usages; for longer periods, aggregates historical usage.
downscaled boolean
restrict_member_access boolean
paused boolean
endpoints array of objects
endpoints.uuid string (uuid)
endpoints.name string
endpoints.url string URL of the access endpoint
error_message string
error_traceback string
options any
available_actions array of strings
last_sync string (date-time)
order_in_progress any
creation_order any
service_settings_uuid string (uuid)
project_slug string
customer_slug string
user_requires_reconsent boolean Check if the current user needs to re-consent for this resource's offering.
renewal_date object (free-form)
offering_state any
offering_components array of objects
offering_components.uuid string (uuid)
offering_components.billing_type string
Enum: fixed, usage, limit, one, few
offering_components.type string Unique internal name of the measured unit, for example floating_ip.
offering_components.name string Display name for the measured unit, for example, Floating IP.
offering_components.description string
offering_components.measured_unit string Unit of measurement, for example, GB.
offering_components.unit_factor integer The conversion factor from backend units to measured_unit
offering_components.limit_period any
offering_components.limit_amount integer
offering_components.article_code string
offering_components.max_value integer
offering_components.min_value integer
offering_components.max_available_limit integer
offering_components.is_boolean boolean
offering_components.default_limit integer
offering_components.factor integer
offering_components.is_builtin boolean
offering_components.is_prepaid boolean
offering_components.overage_component string (uuid)
offering_components.min_prepaid_duration integer
offering_components.max_prepaid_duration integer

Retrieve a provider resource

Returns details of a specific resource from a provider's perspective.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-provider-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.resource_field_enum import ResourceFieldEnum # (1)
from waldur_api_client.api.marketplace_provider_resources import marketplace_provider_resources_retrieve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_provider_resources_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. Model Source: ResourceFieldEnum
  2. API Source: marketplace_provider_resources_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceProviderResourcesRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceProviderResourcesRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type
field array

200 -

Field Type Description
offering string (uri)
offering_name string
offering_uuid string (uuid)
offering_description string
offering_image string (uri)
offering_thumbnail string (uri)
offering_type string
offering_shared boolean Accessible to all customers.
offering_billable boolean Purchase and usage is invoiced.
offering_plugin_options any Public data used by specific plugin, such as storage mode for OpenStack.
provider_name string
provider_uuid string (uuid)
provider_slug string
category_title string
category_uuid string (uuid)
category_icon string (uri)
plan string (uri)
plan_unit any
plan_name string
plan_uuid string (uuid)
plan_description string
attributes object (free-form)
limits object (free-form)
uuid string (uuid)
created string (date-time)
modified string (date-time)
url string (uri)
scope string
description string
state any
resource_uuid string (uuid)
backend_id string
effective_id string
resource_type string
project string (uri)
project_uuid string (uuid)
project_name string
project_description string
project_end_date string (date) The date is inclusive. Once reached, all project resource will be scheduled for termination.
project_end_date_requested_by string (uri)
customer_uuid string (uuid)
customer_name string
offering_slug string
parent_offering_uuid string (uuid)
parent_offering_name string
parent_offering_slug string
offering_backend_id string
parent_uuid string (uuid)
parent_name string
backend_metadata any
is_usage_based boolean Returns True if the resource has usage-based components that track variable consumption.
is_limit_based boolean Returns True if the resource has limit-based components with user-adjustable quotas.
name string
slug string URL-friendly identifier. Only editable by staff users.
current_usages object (free-form) Dictionary mapping component types to their latest reported usage amounts.
can_terminate boolean
report array of objects
report.header string Section header text
report.body string Section body content
end_date string (date) The date is inclusive. Once reached, a resource will be scheduled for termination.
end_date_requested_by string (uri)
username string
limit_usage object (free-form) Dictionary mapping limit-based component types to their consumed usage. For monthly periods, maps from current_usages; for longer periods, aggregates historical usage.
downscaled boolean
restrict_member_access boolean
paused boolean
endpoints array of objects
endpoints.uuid string (uuid)
endpoints.name string
endpoints.url string URL of the access endpoint
error_message string
error_traceback string
options any
available_actions array of strings
last_sync string (date-time)
order_in_progress any
creation_order any
service_settings_uuid string (uuid)
project_slug string
customer_slug string
user_requires_reconsent boolean Check if the current user needs to re-consent for this resource's offering.
renewal_date object (free-form)
offering_state any
offering_components array of objects
offering_components.uuid string (uuid)
offering_components.billing_type string
Enum: fixed, usage, limit, one, few
offering_components.type string Unique internal name of the measured unit, for example floating_ip.
offering_components.name string Display name for the measured unit, for example, Floating IP.
offering_components.description string
offering_components.measured_unit string Unit of measurement, for example, GB.
offering_components.unit_factor integer The conversion factor from backend units to measured_unit
offering_components.limit_period any
offering_components.limit_amount integer
offering_components.article_code string
offering_components.max_value integer
offering_components.min_value integer
offering_components.max_available_limit integer
offering_components.is_boolean boolean
offering_components.default_limit integer
offering_components.factor integer
offering_components.is_builtin boolean
offering_components.is_prepaid boolean
offering_components.overage_component string (uuid)
offering_components.min_prepaid_duration integer
offering_components.max_prepaid_duration integer

Pull resource data

Schedules a task to pull the latest data for the resource from its backend.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-provider-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/pull/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_provider_resources import marketplace_provider_resources_pull # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_provider_resources_pull.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_provider_resources_pull
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceProviderResourcesPull } from 'waldur-js-client';

try {
  const response = await marketplaceProviderResourcesPull({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

202 -

Field Type
detail string

Forcefully deletes a marketplace resource and its related plugin resource from the database. This action does not schedule operations on the backend and is intended for cleaning up resources stuck in transitioning states. Requires staff permissions.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-provider-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/unlink/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_provider_resources import marketplace_provider_resources_unlink # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_provider_resources_unlink.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_provider_resources_unlink
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceProviderResourcesUnlink } from 'waldur-js-client';

try {
  const response = await marketplaceProviderResourcesUnlink({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

403 - No response body

Update resource options

Updates the options of a resource. If the offering is configured to create orders for option changes, a new UPDATE order will be created. Otherwise, the options are updated directly.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-provider-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/update_options/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.resource_options_request import ResourceOptionsRequest # (1)
from waldur_api_client.api.marketplace_provider_resources import marketplace_provider_resources_update_options # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ResourceOptionsRequest()
response = marketplace_provider_resources_update_options.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ResourceOptionsRequest
  2. API Source: marketplace_provider_resources_update_options
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceProviderResourcesUpdateOptions } from 'waldur-js-client';

try {
  const response = await marketplaceProviderResourcesUpdateOptions({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
options any

200 -

Field Type Description
status string Status of the resource response

201 -

Field Type Description
order_uuid string (uuid) UUID of the created or updated order

409 - No response body

Update resource options directly

Allows a service provider to directly update the options of a resource without creating an order. This is typically used for administrative changes or backend synchronization.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-provider-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/update_options_direct/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.resource_options_request import ResourceOptionsRequest # (1)
from waldur_api_client.api.marketplace_provider_resources import marketplace_provider_resources_update_options_direct # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ResourceOptionsRequest()
response = marketplace_provider_resources_update_options_direct.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ResourceOptionsRequest
  2. API Source: marketplace_provider_resources_update_options_direct
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceProviderResourcesUpdateOptionsDirect } from 'waldur-js-client';

try {
  const response = await marketplaceProviderResourcesUpdateOptionsDirect({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
options any

200 -

Field Type Description
status string Status of the resource response

Update a provider resource

Updates the name or description of a resource. Requires provider permissions.

1
2
3
4
5
http \
  PUT \
  https://api.example.com/api/marketplace-provider-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-marketplace-provider-resource"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.resource_update_request import ResourceUpdateRequest # (1)
from waldur_api_client.api.marketplace_provider_resources import marketplace_provider_resources_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ResourceUpdateRequest(
    name="my-awesome-marketplace-provider-resource"
)
response = marketplace_provider_resources_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ResourceUpdateRequest
  2. API Source: marketplace_provider_resources_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { marketplaceProviderResourcesUpdate } from 'waldur-js-client';

try {
  const response = await marketplaceProviderResourcesUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-marketplace-provider-resource"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
name string ✓
description string
end_date string (date) The date is inclusive. Once reached, a resource will be scheduled for termination.

200 -

Field Type Description
name string
description string
end_date string (date) The date is inclusive. Once reached, a resource will be scheduled for termination.

Partially update a provider resource

Partially updates the name or description of a resource. Requires provider permissions.

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/marketplace-provider-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_resource_update_request import PatchedResourceUpdateRequest # (1)
from waldur_api_client.api.marketplace_provider_resources import marketplace_provider_resources_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedResourceUpdateRequest()
response = marketplace_provider_resources_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedResourceUpdateRequest
  2. API Source: marketplace_provider_resources_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceProviderResourcesPartialUpdate } from 'waldur-js-client';

try {
  const response = await marketplaceProviderResourcesPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
name string
description string
end_date string (date) The date is inclusive. Once reached, a resource will be scheduled for termination.

200 -

Field Type Description
name string
description string
end_date string (date) The date is inclusive. Once reached, a resource will be scheduled for termination.

Other Actions

Get resource details

Returns the detailed representation of the backend resource associated with the marketplace resource. The format of the response depends on the resource type.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-provider-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/details/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_provider_resources import marketplace_provider_resources_details_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_provider_resources_details_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_provider_resources_details_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceProviderResourcesDetailsRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceProviderResourcesDetailsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

204 -

404 -

Get GLauth user configuration for a resource

1
2
    This endpoint provides a GLauth configuration file for the users associated with the project of this resource.
    It is intended for use by an external agent to synchronize user data from Waldur to GLauth.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-provider-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/glauth_users_config/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_provider_resources import marketplace_provider_resources_glauth_users_config_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_provider_resources_glauth_users_config_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_provider_resources_glauth_users_config_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceProviderResourcesGlauthUsersConfigRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceProviderResourcesGlauthUsersConfigRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Get object state at a specific timestamp

Returns the state of the object as it was at the specified timestamp. Only accessible by staff and support users.

1
2
3
4
5
http \
  GET \
  https://api.example.com/api/marketplace-provider-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/history/at/ \
  Authorization:"Token YOUR_API_TOKEN" \
  timestamp=="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_provider_resources import marketplace_provider_resources_history_at_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_provider_resources_history_at_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    timestamp="string-value"
)

print(response)
  1. API Source: marketplace_provider_resources_history_at_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { marketplaceProviderResourcesHistoryAtRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceProviderResourcesHistoryAtRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  query: {
    "timestamp": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type Required Description
timestamp string ✓ ISO 8601 timestamp to query the object state at

200 -

Field Type Description
id integer Version ID
revision_date string (date-time) When this revision was created
revision_user object (free-form) User who created this revision
revision_comment string Comment describing the revision
serialized_data object (free-form) Serialized model fields at this revision

400 -

404 -

Get version history

Returns the version history for this object. Only accessible by staff and support users.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-provider-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/history/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.order_state import OrderState # (1)
from waldur_api_client.models.resource_o_enum import ResourceOEnum # (2)
from waldur_api_client.models.resource_state import ResourceState # (3)
from waldur_api_client.api.marketplace_provider_resources import marketplace_provider_resources_history_list # (4)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_provider_resources_history_list.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

for item in response:
    print(item)
  1. Model Source: OrderState
  2. Model Source: ResourceOEnum
  3. Model Source: ResourceState
  4. API Source: marketplace_provider_resources_history_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceProviderResourcesHistoryList } from 'waldur-js-client';

try {
  const response = await marketplaceProviderResourcesHistoryList({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type Description
backend_id string Backend ID
category_uuid string (uuid) Category UUID
component_count number Filter by exact number of components
created string (date-time) Created after
created_after string Filter versions created after this timestamp (ISO 8601)
created_before string Filter versions created before this timestamp (ISO 8601)
customer string (uri) Customer URL
customer_uuid string (uuid) Customer UUID
downscaled boolean Downscaled
has_terminate_date boolean Has termination date
is_attached boolean Filter by attached state
lexis_links_supported boolean LEXIS links supported
limit_based boolean Filter by limit-based offerings
limit_component_count number Filter by exact number of limit-based components
modified string (date-time) Modified after
name string Name
name_exact string Name (exact)
o array Ordering
offering string (uri)
offering_billable boolean Offering billable
offering_shared boolean Offering shared
offering_slug array Multiple values may be separated by commas.
offering_type string Offering type
offering_uuid array Multiple values may be separated by commas.
only_limit_based boolean Filter resources with only limit-based components
only_usage_based boolean Filter resources with only usage-based components
order_state array Order state
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
parent_offering_uuid string (uuid)
paused boolean Paused
plan_uuid string (uuid) Plan UUID
project_name string Project name
project_uuid string (uuid) Project UUID
provider_uuid string (uuid) Provider UUID
query string Search by resource UUID, name, slug, backend ID, effective ID, IPs or hypervisor
restrict_member_access boolean Restrict member access
runtime_state string Runtime state
scope string (uri) Filter by scope URL.
service_manager_uuid string (uuid) Service manager UUID
state array Resource state
usage_based boolean Filter by usage-based offerings
visible_to_providers boolean Include only resources visible to service providers
visible_to_username string Visible to username

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
id integer Version ID
revision_date string (date-time) When this revision was created
revision_user object (free-form) User who created this revision
revision_comment string Comment describing the revision
serialized_data object (free-form) Serialized model fields at this revision

List offerings for sub-resources

Returns a list of offerings that can be provisioned as sub-resources of the current resource.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-provider-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/offering_for_subresources/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_provider_resources import marketplace_provider_resources_offering_for_subresources_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_provider_resources_offering_for_subresources_list.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

for item in response:
    print(item)
  1. API Source: marketplace_provider_resources_offering_for_subresources_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceProviderResourcesOfferingForSubresourcesList } from 'waldur-js-client';

try {
  const response = await marketplaceProviderResourcesOfferingForSubresourcesList({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid) UUID of the offering
type string Type of the offering

Get offering details

Returns details of the offering connected to the requested object.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-provider-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/offering/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_provider_resources import marketplace_provider_resources_offering_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_provider_resources_offering_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_provider_resources_offering_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceProviderResourcesOfferingRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceProviderResourcesOfferingRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
url string (uri)
uuid string (uuid)
created string (date-time)
name string
slug string URL-friendly identifier. Only editable by staff users.
description string
full_description string
privacy_policy_link string (uri)
access_url string (uri) Publicly accessible offering access URL
endpoints array of objects
endpoints.uuid string (uuid)
endpoints.name string
endpoints.url string URL of the access endpoint
software_catalogs array of objects
software_catalogs.uuid string (uuid)
software_catalogs.catalog any
software_catalogs.enabled_cpu_family any List of enabled CPU families: ['x86_64', 'aarch64']
software_catalogs.enabled_cpu_microarchitectures any List of enabled CPU microarchitectures: ['generic', 'zen3']
software_catalogs.package_count integer
software_catalogs.partition any
partitions array of objects
partitions.uuid string (uuid)
partitions.partition_name string Name of the SLURM partition
partitions.cpu_bind integer Default task binding policy (SLURM cpu_bind)
partitions.def_cpu_per_gpu integer Default CPUs allocated per GPU
partitions.max_cpus_per_node integer Maximum allocated CPUs per node
partitions.max_cpus_per_socket integer Maximum allocated CPUs per socket
partitions.def_mem_per_cpu integer (int64) Default memory per CPU in MB
partitions.def_mem_per_gpu integer (int64) Default memory per GPU in MB
partitions.def_mem_per_node integer (int64) Default memory per node in MB
partitions.max_mem_per_cpu integer (int64) Maximum memory per CPU in MB
partitions.max_mem_per_node integer (int64) Maximum memory per node in MB
partitions.default_time integer Default time limit in minutes
partitions.max_time integer Maximum time limit in minutes
partitions.grace_time integer Preemption grace time in seconds
partitions.max_nodes integer Maximum nodes per job
partitions.min_nodes integer Minimum nodes per job
partitions.exclusive_topo boolean Exclusive topology access required
partitions.exclusive_user boolean Exclusive user access required
partitions.priority_tier integer Priority tier for scheduling and preemption
partitions.qos string Quality of Service (QOS) name
partitions.req_resv boolean Require reservation for job allocation
roles array of objects
roles.uuid string (uuid)
roles.name string
roles.url string (uri)
customer string (uri)
customer_uuid string (uuid)
customer_name string
project string (uri)
project_uuid string (uuid)
project_name string
category string (uri)
category_uuid string (uuid)
category_title string
attributes object (free-form)
options any
resource_options any
components array of objects
components.uuid string (uuid)
components.billing_type string
Enum: fixed, usage, limit, one, few
components.type string Unique internal name of the measured unit, for example floating_ip.
components.name string Display name for the measured unit, for example, Floating IP.
components.description string
components.measured_unit string Unit of measurement, for example, GB.
components.unit_factor integer The conversion factor from backend units to measured_unit
components.limit_period any
components.limit_amount integer
components.article_code string
components.max_value integer
components.min_value integer
components.max_available_limit integer
components.is_boolean boolean
components.default_limit integer
components.factor integer
components.is_builtin boolean
components.is_prepaid boolean
components.overage_component string (uuid)
components.min_prepaid_duration integer
components.max_prepaid_duration integer
plugin_options any
state any
vendor_details string
getting_started string
integration_guide string
thumbnail string (uri)
order_count integer
plans array of objects
plans.url string (uri)
plans.uuid string (uuid)
plans.name string
plans.description string
plans.article_code string
plans.max_amount integer Maximum number of plans that could be active. Plan is disabled when maximum amount is reached.
plans.archived boolean Forbids creation of new resources.
plans.is_active boolean
plans.unit_price string (decimal)
plans.unit string
Enum: month, quarter, half_month, day, hour, quantity
plans.init_price number (double)
plans.switch_price number (double)
plans.backend_id string
plans.organization_groups array of objects
plans.organization_groups.uuid string (uuid)
plans.organization_groups.url string (uri)
plans.organization_groups.name string
plans.organization_groups.parent_uuid string (uuid) UUID of the parent organization group
plans.organization_groups.parent_name string Name of the parent organization group
plans.organization_groups.parent string (uri)
plans.organization_groups.customers_count integer Number of customers in this organization group
plans.components array of objects
plans.components.type string Unique internal name of the measured unit, for example floating_ip.
plans.components.name string Display name for the measured unit, for example, Floating IP.
plans.components.measured_unit string Unit of measurement, for example, GB.
plans.components.amount integer
plans.components.price string (decimal)
plans.components.future_price string (decimal)
plans.components.discount_threshold integer Minimum amount to be eligible for discount.
plans.components.discount_rate integer Discount rate in percentage.
plans.prices object (free-form)
plans.future_prices object (free-form)
plans.quotas object (free-form)
plans.resources_count integer
plans.plan_type string
plans.minimal_price number (double)
screenshots array of objects
screenshots.name string
screenshots.uuid string (uuid)
screenshots.description string
screenshots.image string (uri)
screenshots.thumbnail string (uri)
screenshots.created string (date-time)
type string
shared boolean Accessible to all customers.
billable boolean Purchase and usage is invoiced.
scope string
scope_uuid string (uuid)
scope_name string (uuid)
scope_state any
scope_error_message string
files array of objects
files.name string
files.created string (date-time)
files.file string (uri)
quotas array of objects
quotas.name string
quotas.usage integer
quotas.limit integer
paused_reason string
datacite_doi string
citation_count integer Number of citations of a DOI
latitude number (double)
longitude number (double)
country any Country code (ISO 3166-1 alpha-2)
backend_id string
organization_groups array of objects
organization_groups.uuid string (uuid)
organization_groups.url string (uri)
organization_groups.name string
organization_groups.parent_uuid string (uuid) UUID of the parent organization group
organization_groups.parent_name string Name of the parent organization group
organization_groups.parent string (uri)
organization_groups.customers_count integer Number of customers in this organization group
tags array of objects
tags.uuid string (uuid)
tags.name string
image string (uri)
total_customers integer
total_cost integer
total_cost_estimated integer
parent_description string
parent_uuid string (uuid)
parent_name string
backend_metadata any
has_compliance_requirements boolean
billing_type_classification string Classify offering components by billing type. Returns 'limit_only', 'usage_only', or 'mixed'.
compliance_checklist string (uri)
user_has_consent boolean
is_accessible boolean
google_calendar_is_public boolean
google_calendar_link string Get the Google Calendar link for an offering.
promotion_campaigns array of objects
promotion_campaigns.uuid string (uuid)
promotion_campaigns.name string
promotion_campaigns.start_date string (date) Starting from this date, the campaign is active.
promotion_campaigns.end_date string (date) The last day the campaign is active.
promotion_campaigns.discount_type string
Enum: discount, special_price
promotion_campaigns.discount integer
promotion_campaigns.stock integer
promotion_campaigns.description string
promotion_campaigns.months integer How many months in a row should the related service (when activated) get special deal (0 for indefinitely until active)
promotion_campaigns.service_provider string (uri)

List resource plan periods

Returns a list of active and future plan periods for the resource. Each period includes the plan details and current component usage.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-provider-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/plan_periods/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_provider_resources import marketplace_provider_resources_plan_periods_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_provider_resources_plan_periods_list.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

for item in response:
    print(item)
  1. API Source: marketplace_provider_resources_plan_periods_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceProviderResourcesPlanPeriodsList } from 'waldur-js-client';

try {
  const response = await marketplaceProviderResourcesPlanPeriodsList({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid)
plan_name string
plan_uuid string (uuid)
start string (date-time)
end string (date-time)
components array of objects
components.uuid string (uuid)
components.created string (date-time)
components.description string
components.type string Unique internal name of the measured unit, for example floating_ip.
components.name string Display name for the measured unit, for example, Floating IP.
components.measured_unit string Unit of measurement, for example, GB.
components.usage string (decimal)
components.date string (date-time)
components.recurring boolean Reported value is reused every month until changed.

Get resource team

Returns a list of users connected to the project of this resource, including their project roles and offering-specific usernames.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-provider-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/team/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_provider_resources import marketplace_provider_resources_team_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_provider_resources_team_list.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

for item in response:
    print(item)
  1. API Source: marketplace_provider_resources_team_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceProviderResourcesTeamList } from 'waldur-js-client';

try {
  const response = await marketplaceProviderResourcesTeamList({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
full_name string
email string (email)
role string
expiration_time string (date-time)
offering_user_username string
offering_user_state any

Move a resource to another project

Moves a resource and its associated data to a different project. Requires staff permissions.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/marketplace-provider-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/move_resource/ \
  Authorization:"Token YOUR_API_TOKEN" \
  project=null

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.move_resource_request import MoveResourceRequest # (1)
from waldur_api_client.api.marketplace_provider_resources import marketplace_provider_resources_move_resource # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = MoveResourceRequest(
    project=null
)
response = marketplace_provider_resources_move_resource.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: MoveResourceRequest
  2. API Source: marketplace_provider_resources_move_resource
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { marketplaceProviderResourcesMoveResource } from 'waldur-js-client';

try {
  const response = await marketplaceProviderResourcesMoveResource({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "project": null
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
project any ✓ Target project URL where the resource should be moved
Constraints: write-only

200 -

Field Type Description
offering string (uri)
offering_name string
offering_uuid string (uuid)
offering_description string
offering_image string (uri)
offering_thumbnail string (uri)
offering_type string
offering_shared boolean Accessible to all customers.
offering_billable boolean Purchase and usage is invoiced.
offering_plugin_options any Public data used by specific plugin, such as storage mode for OpenStack.
provider_name string
provider_uuid string (uuid)
provider_slug string
category_title string
category_uuid string (uuid)
category_icon string (uri)
plan string (uri)
plan_unit any
plan_name string
plan_uuid string (uuid)
plan_description string
attributes object (free-form)
limits object (free-form)
uuid string (uuid)
created string (date-time)
modified string (date-time)
url string (uri)
scope string
description string
state any
resource_uuid string (uuid)
backend_id string
effective_id string
resource_type string
project string (uri)
project_uuid string (uuid)
project_name string
project_description string
project_end_date string (date) The date is inclusive. Once reached, all project resource will be scheduled for termination.
project_end_date_requested_by string (uri)
customer_uuid string (uuid)
customer_name string
offering_slug string
parent_offering_uuid string (uuid)
parent_offering_name string
parent_offering_slug string
offering_backend_id string
parent_uuid string (uuid)
parent_name string
backend_metadata any
is_usage_based boolean Returns True if the resource has usage-based components that track variable consumption.
is_limit_based boolean Returns True if the resource has limit-based components with user-adjustable quotas.
name string
slug string URL-friendly identifier. Only editable by staff users.
current_usages object (free-form) Dictionary mapping component types to their latest reported usage amounts.
can_terminate boolean
report array of objects
report.header string Section header text
report.body string Section body content
end_date string (date) The date is inclusive. Once reached, a resource will be scheduled for termination.
end_date_requested_by string (uri)
username string
limit_usage object (free-form) Dictionary mapping limit-based component types to their consumed usage. For monthly periods, maps from current_usages; for longer periods, aggregates historical usage.
downscaled boolean
restrict_member_access boolean
paused boolean
endpoints array of objects
endpoints.uuid string (uuid)
endpoints.name string
endpoints.url string URL of the access endpoint
error_message string
error_traceback string
options any
available_actions array of strings
last_sync string (date-time)
order_in_progress any
creation_order any
service_settings_uuid string (uuid)
project_slug string
customer_slug string
user_requires_reconsent boolean Check if the current user needs to re-consent for this resource's offering.
renewal_date object (free-form)
offering_state any
offering_components array of objects
offering_components.uuid string (uuid)
offering_components.billing_type string
Enum: fixed, usage, limit, one, few
offering_components.type string Unique internal name of the measured unit, for example floating_ip.
offering_components.name string Display name for the measured unit, for example, Floating IP.
offering_components.description string
offering_components.measured_unit string Unit of measurement, for example, GB.
offering_components.unit_factor integer The conversion factor from backend units to measured_unit
offering_components.limit_period any
offering_components.limit_amount integer
offering_components.article_code string
offering_components.max_value integer
offering_components.min_value integer
offering_components.max_available_limit integer
offering_components.is_boolean boolean
offering_components.default_limit integer
offering_components.factor integer
offering_components.is_builtin boolean
offering_components.is_prepaid boolean
offering_components.overage_component string (uuid)
offering_components.min_prepaid_duration integer
offering_components.max_prepaid_duration integer

Refresh last sync time

Updates the 'last_sync' timestamp for a resource to the current time. This is useful for backend agents to signal that a resource is being actively monitored.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-provider-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/refresh_last_sync/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_provider_resources import marketplace_provider_resources_refresh_last_sync # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_provider_resources_refresh_last_sync.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_provider_resources_refresh_last_sync
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceProviderResourcesRefreshLastSync } from 'waldur-js-client';

try {
  const response = await marketplaceProviderResourcesRefreshLastSync({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 - No response body

Restore

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/marketplace-provider-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/restore/ \
  Authorization:"Token YOUR_API_TOKEN" \
  offering="https://api.example.com/api/offering/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  name="my-awesome-marketplace-provider-resource"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.resource_request import ResourceRequest # (1)
from waldur_api_client.api.marketplace_provider_resources import marketplace_provider_resources_restore # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ResourceRequest(
    offering="https://api.example.com/api/offering/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    name="my-awesome-marketplace-provider-resource"
)
response = marketplace_provider_resources_restore.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ResourceRequest
  2. API Source: marketplace_provider_resources_restore
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { marketplaceProviderResourcesRestore } from 'waldur-js-client';

try {
  const response = await marketplaceProviderResourcesRestore({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "offering": "https://api.example.com/api/offering/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "name": "my-awesome-marketplace-provider-resource"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
offering string (uri) ✓
plan string (uri)
name string ✓
slug string URL-friendly identifier. Only editable by staff users.
end_date string (date) The date is inclusive. Once reached, a resource will be scheduled for termination.
downscaled boolean
paused boolean

200 -

Field Type Description
offering string (uri)
offering_name string
offering_uuid string (uuid)
offering_description string
offering_image string (uri)
offering_thumbnail string (uri)
offering_type string
offering_shared boolean Accessible to all customers.
offering_billable boolean Purchase and usage is invoiced.
offering_plugin_options any Public data used by specific plugin, such as storage mode for OpenStack.
provider_name string
provider_uuid string (uuid)
provider_slug string
category_title string
category_uuid string (uuid)
category_icon string (uri)
plan string (uri)
plan_unit any
plan_name string
plan_uuid string (uuid)
plan_description string
attributes object (free-form)
limits object (free-form)
uuid string (uuid)
created string (date-time)
modified string (date-time)
url string (uri)
scope string
description string
state any
resource_uuid string (uuid)
backend_id string
effective_id string
resource_type string
project string (uri)
project_uuid string (uuid)
project_name string
project_description string
project_end_date string (date) The date is inclusive. Once reached, all project resource will be scheduled for termination.
project_end_date_requested_by string (uri)
customer_uuid string (uuid)
customer_name string
offering_slug string
parent_offering_uuid string (uuid)
parent_offering_name string
parent_offering_slug string
offering_backend_id string
parent_uuid string (uuid)
parent_name string
backend_metadata any
is_usage_based boolean Returns True if the resource has usage-based components that track variable consumption.
is_limit_based boolean Returns True if the resource has limit-based components with user-adjustable quotas.
name string
slug string URL-friendly identifier. Only editable by staff users.
current_usages object (free-form) Dictionary mapping component types to their latest reported usage amounts.
can_terminate boolean
report array of objects
report.header string Section header text
report.body string Section body content
end_date string (date) The date is inclusive. Once reached, a resource will be scheduled for termination.
end_date_requested_by string (uri)
username string
limit_usage object (free-form) Dictionary mapping limit-based component types to their consumed usage. For monthly periods, maps from current_usages; for longer periods, aggregates historical usage.
downscaled boolean
restrict_member_access boolean
paused boolean
endpoints array of objects
endpoints.uuid string (uuid)
endpoints.name string
endpoints.url string URL of the access endpoint
error_message string
error_traceback string
options any
available_actions array of strings
last_sync string (date-time)
order_in_progress any
creation_order any
service_settings_uuid string (uuid)
project_slug string
customer_slug string
user_requires_reconsent boolean Check if the current user needs to re-consent for this resource's offering.
renewal_date object (free-form)
offering_state any
offering_components array of objects
offering_components.uuid string (uuid)
offering_components.billing_type string
Enum: fixed, usage, limit, one, few
offering_components.type string Unique internal name of the measured unit, for example floating_ip.
offering_components.name string Display name for the measured unit, for example, Floating IP.
offering_components.description string
offering_components.measured_unit string Unit of measurement, for example, GB.
offering_components.unit_factor integer The conversion factor from backend units to measured_unit
offering_components.limit_period any
offering_components.limit_amount integer
offering_components.article_code string
offering_components.max_value integer
offering_components.min_value integer
offering_components.max_available_limit integer
offering_components.is_boolean boolean
offering_components.default_limit integer
offering_components.factor integer
offering_components.is_builtin boolean
offering_components.is_prepaid boolean
offering_components.overage_component string (uuid)
offering_components.min_prepaid_duration integer
offering_components.max_prepaid_duration integer

Set resource state to erred

Allows a service provider to manually set the state of a resource to 'erred'. An error message and traceback can be provided.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-provider-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_as_erred/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.resource_set_state_erred_request import ResourceSetStateErredRequest # (1)
from waldur_api_client.api.marketplace_provider_resources import marketplace_provider_resources_set_as_erred # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ResourceSetStateErredRequest()
response = marketplace_provider_resources_set_as_erred.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ResourceSetStateErredRequest
  2. API Source: marketplace_provider_resources_set_as_erred
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceProviderResourcesSetAsErred } from 'waldur-js-client';

try {
  const response = await marketplaceProviderResourcesSetAsErred({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
error_message string
error_traceback string

200 - No response body

Set resource state to OK

Allows a service provider to manually set the state of a resource to 'OK', clearing any previous error messages.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-provider-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_as_ok/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_provider_resources import marketplace_provider_resources_set_as_ok # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_provider_resources_set_as_ok.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_provider_resources_set_as_ok
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceProviderResourcesSetAsOk } from 'waldur-js-client';

try {
  const response = await marketplaceProviderResourcesSetAsOk({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 - No response body

Set resource backend ID

Allows a service provider to set or update the backend ID for a resource, linking it to an external system's identifier.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-provider-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_backend_id/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.resource_backend_id_request import ResourceBackendIDRequest # (1)
from waldur_api_client.api.marketplace_provider_resources import marketplace_provider_resources_set_backend_id # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ResourceBackendIDRequest()
response = marketplace_provider_resources_set_backend_id.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ResourceBackendIDRequest
  2. API Source: marketplace_provider_resources_set_backend_id
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceProviderResourcesSetBackendId } from 'waldur-js-client';

try {
  const response = await marketplaceProviderResourcesSetBackendId({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
backend_id string

200 -

Field Type Description
status string Status of the resource response

Set resource backend metadata

Allows a service provider to set or update the backend-specific metadata for a resource.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/marketplace-provider-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_backend_metadata/ \
  Authorization:"Token YOUR_API_TOKEN" \
  backend_metadata=null

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.resource_backend_metadata_request import ResourceBackendMetadataRequest # (1)
from waldur_api_client.api.marketplace_provider_resources import marketplace_provider_resources_set_backend_metadata # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ResourceBackendMetadataRequest(
    backend_metadata=null
)
response = marketplace_provider_resources_set_backend_metadata.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ResourceBackendMetadataRequest
  2. API Source: marketplace_provider_resources_set_backend_metadata
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { marketplaceProviderResourcesSetBackendMetadata } from 'waldur-js-client';

try {
  const response = await marketplaceProviderResourcesSetBackendMetadata({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "backend_metadata": null
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
backend_metadata any ✓

200 -

Field Type Description
status string Status of the resource response

Set downscaled flag for resource

Sets the 'downscaled' flag for a resource. Requires staff permissions.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-provider-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_downscaled/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.resource_downscaled_request import ResourceDownscaledRequest # (1)
from waldur_api_client.api.marketplace_provider_resources import marketplace_provider_resources_set_downscaled # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ResourceDownscaledRequest()
response = marketplace_provider_resources_set_downscaled.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ResourceDownscaledRequest
  2. API Source: marketplace_provider_resources_set_downscaled
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceProviderResourcesSetDownscaled } from 'waldur-js-client';

try {
  const response = await marketplaceProviderResourcesSetDownscaled({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
downscaled boolean

200 -

Field Type
status string

Set end date by provider

Allows a service provider to set or update the end date for a resource, scheduling it for termination. A notification is sent to the consumer.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-provider-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_end_date_by_provider/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.resource_end_date_by_provider_request import ResourceEndDateByProviderRequest # (1)
from waldur_api_client.api.marketplace_provider_resources import marketplace_provider_resources_set_end_date_by_provider # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ResourceEndDateByProviderRequest()
response = marketplace_provider_resources_set_end_date_by_provider.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ResourceEndDateByProviderRequest
  2. API Source: marketplace_provider_resources_set_end_date_by_provider
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceProviderResourcesSetEndDateByProvider } from 'waldur-js-client';

try {
  const response = await marketplaceProviderResourcesSetEndDateByProvider({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
end_date string (date) The date is inclusive. Once reached, a resource will be scheduled for termination.

200 - No response body

Set end date of the resource by staff

Allows a staff user to set or update the end date for a resource, which will schedule it for termination.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-provider-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_end_date_by_staff/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.resource_end_date_by_provider_request import ResourceEndDateByProviderRequest # (1)
from waldur_api_client.api.marketplace_provider_resources import marketplace_provider_resources_set_end_date_by_staff # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ResourceEndDateByProviderRequest()
response = marketplace_provider_resources_set_end_date_by_staff.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ResourceEndDateByProviderRequest
  2. API Source: marketplace_provider_resources_set_end_date_by_staff
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceProviderResourcesSetEndDateByStaff } from 'waldur-js-client';

try {
  const response = await marketplaceProviderResourcesSetEndDateByStaff({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
end_date string (date) The date is inclusive. Once reached, a resource will be scheduled for termination.

200 - No response body

Set Keycloak scope options for a resource

Allows a service provider to configure available scope options for Keycloak memberships on a resource. Requires Keycloak integration to be enabled on the offering.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/marketplace-provider-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_keycloak_scopes/ \
  Authorization:"Token YOUR_API_TOKEN" \
  keycloak_available_scopes:='[]'

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.resource_keycloak_scopes_request import ResourceKeycloakScopesRequest # (1)
from waldur_api_client.api.marketplace_provider_resources import marketplace_provider_resources_set_keycloak_scopes # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ResourceKeycloakScopesRequest(
    keycloak_available_scopes=[]
)
response = marketplace_provider_resources_set_keycloak_scopes.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ResourceKeycloakScopesRequest
  2. API Source: marketplace_provider_resources_set_keycloak_scopes
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { marketplaceProviderResourcesSetKeycloakScopes } from 'waldur-js-client';

try {
  const response = await marketplaceProviderResourcesSetKeycloakScopes({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "keycloak_available_scopes": []
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
keycloak_available_scopes array of objects ✓ Pre-configured scope options for this resource.
keycloak_available_scopes.scope_type string ✓ Scope type, e.g. 'project', 'cluster'.
keycloak_available_scopes.scope_id string ✓ Identifier of the scope (UUID or external ID).
keycloak_available_scopes.label string ✓ Human-readable label shown to end users.

200 -

Field Type Description
status string Status of the resource response

Set resource limits

Allows a service provider to directly set the limits for a resource. This is typically used for administrative changes or backend synchronization, bypassing the normal order process.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/marketplace-provider-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_limits/ \
  Authorization:"Token YOUR_API_TOKEN" \
  limits=null

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.resource_set_limits_request import ResourceSetLimitsRequest # (1)
from waldur_api_client.api.marketplace_provider_resources import marketplace_provider_resources_set_limits # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ResourceSetLimitsRequest(
    limits=null
)
response = marketplace_provider_resources_set_limits.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ResourceSetLimitsRequest
  2. API Source: marketplace_provider_resources_set_limits
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { marketplaceProviderResourcesSetLimits } from 'waldur-js-client';

try {
  const response = await marketplaceProviderResourcesSetLimits({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "limits": null
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
limits any ✓ Dictionary mapping component types to their new limit values

200 -

Field Type Description
status string Status of the resource response

Set paused flag for resource

Sets the 'paused' flag for a resource. Requires staff permissions.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-provider-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_paused/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.resource_paused_request import ResourcePausedRequest # (1)
from waldur_api_client.api.marketplace_provider_resources import marketplace_provider_resources_set_paused # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ResourcePausedRequest()
response = marketplace_provider_resources_set_paused.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ResourcePausedRequest
  2. API Source: marketplace_provider_resources_set_paused
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceProviderResourcesSetPaused } from 'waldur-js-client';

try {
  const response = await marketplaceProviderResourcesSetPaused({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
paused boolean

200 -

Field Type
status string

Set restrict member access flag

Sets the 'restrict_member_access' flag for a resource. Requires staff permissions.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-provider-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_restrict_member_access/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.resource_restrict_member_access_request import ResourceRestrictMemberAccessRequest # (1)
from waldur_api_client.api.marketplace_provider_resources import marketplace_provider_resources_set_restrict_member_access # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ResourceRestrictMemberAccessRequest()
response = marketplace_provider_resources_set_restrict_member_access.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ResourceRestrictMemberAccessRequest
  2. API Source: marketplace_provider_resources_set_restrict_member_access
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceProviderResourcesSetRestrictMemberAccess } from 'waldur-js-client';

try {
  const response = await marketplaceProviderResourcesSetRestrictMemberAccess({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
restrict_member_access boolean

200 -

Field Type
status string

Set resource slug

Updates the slug for a resource. Requires staff permissions.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/marketplace-provider-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_slug/ \
  Authorization:"Token YOUR_API_TOKEN" \
  slug="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.resource_slug_request import ResourceSlugRequest # (1)
from waldur_api_client.api.marketplace_provider_resources import marketplace_provider_resources_set_slug # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ResourceSlugRequest(
    slug="string-value"
)
response = marketplace_provider_resources_set_slug.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ResourceSlugRequest
  2. API Source: marketplace_provider_resources_set_slug
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { marketplaceProviderResourcesSetSlug } from 'waldur-js-client';

try {
  const response = await marketplaceProviderResourcesSetSlug({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "slug": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
slug string ✓

200 -

Field Type
status string

Set resource state to OK

Allows a service provider to manually set the resource state to OK. This is useful for recovering from Erred state.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-provider-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_state_ok/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_provider_resources import marketplace_provider_resources_set_state_ok # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_provider_resources_set_state_ok.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_provider_resources_set_state_ok
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceProviderResourcesSetStateOk } from 'waldur-js-client';

try {
  const response = await marketplaceProviderResourcesSetStateOk({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
status string Status of the resource response

Submit a report for a resource

Allows a service provider to submit a report (e.g., usage or status report) for a resource.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/marketplace-provider-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/submit_report/ \
  Authorization:"Token YOUR_API_TOKEN" \
  report:='[]'

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.resource_report_request import ResourceReportRequest # (1)
from waldur_api_client.api.marketplace_provider_resources import marketplace_provider_resources_submit_report # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ResourceReportRequest(
    report=[]
)
response = marketplace_provider_resources_submit_report.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ResourceReportRequest
  2. API Source: marketplace_provider_resources_submit_report
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { marketplaceProviderResourcesSubmitReport } from 'waldur-js-client';

try {
  const response = await marketplaceProviderResourcesSubmitReport({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "report": []
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
report array of objects ✓
report.header string ✓ Section header text
report.body string ✓ Section body content

200 -

Field Type Description
status string Status of the resource response

Terminate a resource

Creates a marketplace order to terminate the resource. This action is asynchronous and may require approval.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-provider-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/terminate/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.resource_terminate_request import ResourceTerminateRequest # (1)
from waldur_api_client.api.marketplace_provider_resources import marketplace_provider_resources_terminate # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ResourceTerminateRequest()
response = marketplace_provider_resources_terminate.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ResourceTerminateRequest
  2. API Source: marketplace_provider_resources_terminate
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceProviderResourcesTerminate } from 'waldur-js-client';

try {
  const response = await marketplaceProviderResourcesTerminate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
attributes any Optional attributes/parameters to pass to the termination operation

200 -

Field Type Description
order_uuid string (uuid) UUID of the created or updated order

Marketplace Service Providers

Operations Summary

Method Endpoint Description
GET /api/marketplace-service-providers/{service_provider_uuid}/course_accounts/ List course project accounts for a service provider
GET /api/marketplace-service-providers/{service_provider_uuid}/customer_projects/ List customer projects of a service provider
GET /api/marketplace-service-providers/{service_provider_uuid}/customers/ List customers of a service provider
GET /api/marketplace-service-providers/{service_provider_uuid}/keys/ List SSH keys of a service provider
GET /api/marketplace-service-providers/ List service providers
GET /api/marketplace-service-providers/{uuid}/list_users/ List users and their roles in a scope
GET /api/marketplace-service-providers/{service_provider_uuid}/offerings/ List offerings of a service provider
GET /api/marketplace-service-providers/{service_provider_uuid}/project_permissions/ List project permissions of a service provider
GET /api/marketplace-service-providers/{service_provider_uuid}/project_service_accounts/ List project service accounts for a service provider
GET /api/marketplace-service-providers/{service_provider_uuid}/projects/ List projects of a service provider
GET /api/marketplace-service-providers/{uuid}/ Retrieve a service provider
GET /api/marketplace-service-providers/{uuid}/revenue/ Get service provider revenue
GET /api/marketplace-service-providers/{uuid}/robot_account_customers/ List customers with robot accounts
GET /api/marketplace-service-providers/{uuid}/robot_account_projects/ List projects with robot accounts
GET /api/marketplace-service-providers/{uuid}/stat/ Get service provider statistics
GET /api/marketplace-service-providers/{service_provider_uuid}/user_customers/ List customers of a specific user within a service provider's scope
GET /api/marketplace-service-providers/{service_provider_uuid}/users/ List users of a service provider
GET /api/marketplace-service-providers/{uuid}/api_secret_code/ Get service provider API secret code
GET /api/marketplace-service-providers/{service_provider_uuid}/compliance/checklists_summary/ Get summary of compliance checklists
GET /api/marketplace-service-providers/{service_provider_uuid}/compliance/compliance_overview/ Get compliance overview for a service provider
GET /api/marketplace-service-providers/{service_provider_uuid}/compliance/offering_users/ List offering users' compliance status
POST /api/marketplace-service-providers/{uuid}/add_user/ Grant a role to a user
POST /api/marketplace-service-providers/ Create a service provider
POST /api/marketplace-service-providers/{uuid}/delete_user/ Revoke a role from a user
POST /api/marketplace-service-providers/{uuid}/generate_site_agent_config/ Generate site agent configuration
POST /api/marketplace-service-providers/{uuid}/set_offerings_username/ Set offering username for a user
POST /api/marketplace-service-providers/{uuid}/update_user/ Update a user's role expiration
POST /api/marketplace-service-providers/{uuid}/api_secret_code/ Generate new service provider API secret code
PUT /api/marketplace-service-providers/{uuid}/ Update a service provider
PATCH /api/marketplace-service-providers/{uuid}/ Partially update a service provider
DELETE /api/marketplace-service-providers/{uuid}/ Delete a service provider

List course project accounts for a service provider

Returns a paginated list of course project accounts that have access to resources managed by the provider.

1
2
3
    This includes:
    - Projects with active resources of the service provider.
    - Course accounts with non-blank users.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-service-providers/a1b2c3d4-e5f6-7890-abcd-ef1234567890/course_accounts/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.course_account_o_enum import CourseAccountOEnum # (1)
from waldur_api_client.models.service_account_state import ServiceAccountState # (2)
from waldur_api_client.api.marketplace_service_providers import marketplace_service_providers_course_accounts_list # (3)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_service_providers_course_accounts_list.sync(
    service_provider_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

for item in response:
    print(item)
  1. Model Source: CourseAccountOEnum
  2. Model Source: ServiceAccountState
  3. API Source: marketplace_service_providers_course_accounts_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceServiceProvidersCourseAccountsList } from 'waldur-js-client';

try {
  const response = await marketplaceServiceProvidersCourseAccountsList({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "service_provider_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
service_provider_uuid string (uuid) ✓
Name Type Description
email string Email contains
o array Ordering
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
project_end_date_after string (date) Project end date range
project_end_date_before string (date) Project end date range
project_start_date_after string (date) Project start date range
project_start_date_before string (date) Project start date range
project_uuid string (uuid) Project UUID
state array Course account state
username string Username

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
url string (uri)
uuid string (uuid)
created string (date-time)
modified string (date-time)
project string (uuid)
project_uuid string (uuid)
project_name string
project_slug string
project_start_date string (date)
project_end_date string (date)
user_uuid string (uuid)
username string
customer_uuid string (uuid)
customer_name string
state any
email string (email)
description string
error_message string
error_traceback string

List customer projects of a service provider

Returns a paginated list of projects belonging to a specific customer that have consumed resources from the specified service provider.

1
2
3
4
5
http \
  GET \
  https://api.example.com/api/marketplace-service-providers/a1b2c3d4-e5f6-7890-abcd-ef1234567890/customer_projects/ \
  Authorization:"Token YOUR_API_TOKEN" \
  project_customer_uuid=="a1b2c3d4-e5f6-7890-abcd-ef1234567890"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.marketplace_provider_customer_project_field_enum import MarketplaceProviderCustomerProjectFieldEnum # (1)
from waldur_api_client.models.marketplace_provider_customer_project_o_enum import MarketplaceProviderCustomerProjectOEnum # (2)
from waldur_api_client.api.marketplace_service_providers import marketplace_service_providers_customer_projects_list # (3)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_service_providers_customer_projects_list.sync(
    service_provider_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    project_customer_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
)

for item in response:
    print(item)
  1. Model Source: MarketplaceProviderCustomerProjectFieldEnum
  2. Model Source: MarketplaceProviderCustomerProjectOEnum
  3. API Source: marketplace_service_providers_customer_projects_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { marketplaceServiceProvidersCustomerProjectsList } from 'waldur-js-client';

try {
  const response = await marketplaceServiceProvidersCustomerProjectsList({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "service_provider_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  query: {
    "project_customer_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
service_provider_uuid string (uuid) ✓
Name Type Required Description
backend_id string
can_admin boolean Return a list of projects where current user is admin.
can_manage boolean Return a list of projects where current user is manager or a customer owner.
conceal_finished_projects boolean Conceal finished projects
created string (date-time) Created after
customer array Multiple values may be separated by commas.
customer_abbreviation string Customer abbreviation
customer_name string Customer name
customer_native_name string Customer native name
description string Description
field array
is_removed boolean Is removed
modified string (date-time) Modified after
name string Name
name_exact string Name (exact)
o array Ordering
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
project_customer_uuid string (uuid) ✓ UUID of the customer to filter projects by.
query string Filter by name, slug, UUID, backend ID or resource effective ID
slug string Slug

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid)
name string
description string
end_date string (date) The date is inclusive. Once reached, all project resource will be scheduled for termination.
resources_count integer
users_count integer
billing_price_estimate any

List customers of a service provider

Returns a paginated list of customers who have consumed resources from the specified service provider.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-service-providers/a1b2c3d4-e5f6-7890-abcd-ef1234567890/customers/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.marketplace_provider_customer_field_enum import MarketplaceProviderCustomerFieldEnum # (1)
from waldur_api_client.api.marketplace_service_providers import marketplace_service_providers_customers_list # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_service_providers_customers_list.sync(
    service_provider_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

for item in response:
    print(item)
  1. Model Source: MarketplaceProviderCustomerFieldEnum
  2. API Source: marketplace_service_providers_customers_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceServiceProvidersCustomersList } from 'waldur-js-client';

try {
  const response = await marketplaceServiceProvidersCustomersList({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "service_provider_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
service_provider_uuid string (uuid) ✓
Name Type Description
abbreviation string Abbreviation
agreement_number string
archived boolean
backend_id string
contact_details string Contact details
current_user_has_project_create_permission boolean Return a list of customers where current user has project create permission.
field array
name string Name
name_exact string Name (exact)
native_name string Native name
organization_group_name string Organization group name
organization_group_uuid array Organization group UUID
owned_by_current_user boolean Return a list of customers where current user is owner.
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
query string Filter by name, native name, abbreviation, domain, UUID, registration code or agreement number
registration_code string

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
uuid string (uuid)
name string
slug string
abbreviation string
phone_number string
email string (email)
payment_profiles array of objects
payment_profiles.uuid string (uuid)
payment_profiles.url string (uri)
payment_profiles.name string
payment_profiles.organization_uuid string (uuid)
payment_profiles.organization string (uri)
payment_profiles.attributes object
payment_profiles.attributes.end_date string
payment_profiles.attributes.agreement_number string
payment_profiles.attributes.contract_sum integer
payment_profiles.payment_type string
payment_profiles.payment_type_display string
payment_profiles.is_active boolean
billing_price_estimate any
projects_count integer
users_count integer
projects array of objects
projects.uuid string (uuid)
projects.name string
projects.image string (uri)
users array of objects
users.uuid string (uuid)
users.full_name string
users.email string (email)
users.image string (uri)

List SSH keys of a service provider

Returns a paginated list of SSH public keys for all users who have consumed resources from the specified service provider.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-service-providers/a1b2c3d4-e5f6-7890-abcd-ef1234567890/keys/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.ssh_key_field_enum import SshKeyFieldEnum # (1)
from waldur_api_client.models.ssh_key_o_enum import SshKeyOEnum # (2)
from waldur_api_client.api.marketplace_service_providers import marketplace_service_providers_keys_list # (3)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_service_providers_keys_list.sync(
    service_provider_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

for item in response:
    print(item)
  1. Model Source: SshKeyFieldEnum
  2. Model Source: SshKeyOEnum
  3. API Source: marketplace_service_providers_keys_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceServiceProvidersKeysList } from 'waldur-js-client';

try {
  const response = await marketplaceServiceProvidersKeysList({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "service_provider_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
service_provider_uuid string (uuid) ✓
Name Type Description
created string (date-time) Created after
field array
fingerprint_md5 string
fingerprint_sha256 string
fingerprint_sha512 string
is_shared boolean
modified string (date-time) Modified after
name string Name
name_exact string Name (exact)
o array Ordering
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
user_uuid string (uuid) User UUID
uuid string (uuid) UUID

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
url string (uri)
uuid string (uuid)
name string
public_key string
fingerprint_md5 string
fingerprint_sha256 string
fingerprint_sha512 string
user_uuid string (uuid)
is_shared boolean
type string

List service providers

Returns a paginated list of service providers.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-service-providers/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.call_managing_organisation_o_enum import CallManagingOrganisationOEnum # (1)
from waldur_api_client.models.service_provider_field_enum import ServiceProviderFieldEnum # (2)
from waldur_api_client.api.marketplace_service_providers import marketplace_service_providers_list # (3)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_service_providers_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: CallManagingOrganisationOEnum
  2. Model Source: ServiceProviderFieldEnum
  3. API Source: marketplace_service_providers_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceServiceProvidersList } from 'waldur-js-client';

try {
  const response = await marketplaceServiceProvidersList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
customer string (uri) Customer URL
customer_keyword string Customer keyword (name, abbreviation or native name)
customer_uuid string (uuid) Customer UUID
field array
o array Ordering
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
created string (date-time)
description string
enable_notifications boolean
customer string (uri)
customer_name string
customer_uuid string (uuid)
customer_image string (uri)
customer_abbreviation string
customer_slug string
customer_native_name string
customer_country string
image string (uri)
organization_groups array of objects
organization_groups.uuid string (uuid)
organization_groups.url string (uri)
organization_groups.name string
organization_groups.parent_uuid string (uuid) UUID of the parent organization group
organization_groups.parent_name string Name of the parent organization group
organization_groups.parent string (uri)
organization_groups.customers_count integer Number of customers in this organization group
offering_count integer

List users and their roles in a scope

Retrieves a list of users who have a role within a specific scope (e.g., a project or an organization). The list can be filtered by user details or role.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-service-providers/a1b2c3d4-e5f6-7890-abcd-ef1234567890/list_users/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.user_role_details_field_enum import UserRoleDetailsFieldEnum # (1)
from waldur_api_client.models.user_role_details_o_enum import UserRoleDetailsOEnum # (2)
from waldur_api_client.api.marketplace_service_providers import marketplace_service_providers_list_users_list # (3)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_service_providers_list_users_list.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

for item in response:
    print(item)
  1. Model Source: UserRoleDetailsFieldEnum
  2. Model Source: UserRoleDetailsOEnum
  3. API Source: marketplace_service_providers_list_users_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceServiceProvidersListUsersList } from 'waldur-js-client';

try {
  const response = await marketplaceServiceProvidersListUsersList({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type Description
field array Fields to include in response
full_name string User full name
native_name string User native name
o array Ordering fields
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
role string (uuid) Role UUID or name
search_string string Search string for user
user string (uuid) User UUID
user_slug string User slug
user_url string User URL
username string User username

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid)
created string (date-time)
expiration_time string (date-time)
role_name string
role_uuid string (uuid)
user_email string (email)
user_full_name string
user_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
user_uuid string (uuid)
user_image string (uri)
created_by_full_name string
created_by_uuid string (uuid)

List offerings of a service provider

Returns a paginated list of all billable, shared offerings provided by the specified service provider.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-service-providers/a1b2c3d4-e5f6-7890-abcd-ef1234567890/offerings/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.offering_state import OfferingState # (1)
from waldur_api_client.models.provider_offering_details_o_enum import ProviderOfferingDetailsOEnum # (2)
from waldur_api_client.models.provider_offering_field_enum import ProviderOfferingFieldEnum # (3)
from waldur_api_client.api.marketplace_service_providers import marketplace_service_providers_offerings_list # (4)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_service_providers_offerings_list.sync(
    service_provider_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

for item in response:
    print(item)
  1. Model Source: OfferingState
  2. Model Source: ProviderOfferingDetailsOEnum
  3. Model Source: ProviderOfferingFieldEnum
  4. API Source: marketplace_service_providers_offerings_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceServiceProvidersOfferingsList } from 'waldur-js-client';

try {
  const response = await marketplaceServiceProvidersOfferingsList({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "service_provider_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
service_provider_uuid string (uuid) ✓
Name Type Description
accessible_via_calls boolean Accessible via calls
allowed_customer_uuid string (uuid) Allowed customer UUID
attributes string Offering attributes (JSON)
billable boolean Billable
can_create_offering_user boolean
category_group_uuid string (uuid) Category group UUID
category_uuid string (uuid) Category UUID
created string (date-time) Created after
customer string (uri) Customer URL
customer_uuid string (uuid) Customer UUID
description string Description contains
field array
has_active_terms_of_service boolean Has Active Terms of Service
has_terms_of_service boolean Has Terms of Service
keyword string Keyword
modified string (date-time) Modified after
name string Name
name_exact string Name (exact)
o array Ordering
organization_group_uuid string (uuid) Organization group UUID
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
parent_uuid string (uuid) Parent offering UUID
project_uuid string (uuid) Project UUID
query string Search by offering name, slug or description
resource_customer_uuid string (uuid) Resource customer UUID
resource_project_uuid string (uuid) Resource project UUID
scope_uuid string Scope UUID
service_manager_uuid string (uuid) Service manager UUID
shared boolean Shared
state array Offering state
tag array Tag UUID (OR logic)
tag_name array Tag name (OR logic)
tag_names_and string Tag names with AND logic (comma-separated)
tags_and string Tag UUIDs with AND logic (comma-separated)
type array Offering type
user_has_consent boolean User Has Consent
user_has_offering_user boolean User Has Offering User
uuid_list string Comma-separated offering UUIDs

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid)
customer_uuid string (uuid)
name string
slug string URL-friendly identifier. Only editable by staff users.
category_title string
type string
state any
resources_count integer
billing_price_estimate any
components array of objects
components.uuid string (uuid)
components.billing_type string
Enum: fixed, usage, limit, one, few
components.type string Unique internal name of the measured unit, for example floating_ip.
components.name string Display name for the measured unit, for example, Floating IP.
components.description string
components.measured_unit string Unit of measurement, for example, GB.
components.unit_factor integer The conversion factor from backend units to measured_unit
components.limit_period any
components.limit_amount integer
components.article_code string
components.max_value integer
components.min_value integer
components.max_available_limit integer
components.is_boolean boolean
components.default_limit integer
components.factor integer
components.is_builtin boolean
components.is_prepaid boolean
components.overage_component string (uuid)
components.min_prepaid_duration integer
components.max_prepaid_duration integer
plans array of objects
plans.url string (uri)
plans.uuid string (uuid)
plans.name string
plans.description string
plans.article_code string
plans.max_amount integer Maximum number of plans that could be active. Plan is disabled when maximum amount is reached.
plans.archived boolean Forbids creation of new resources.
plans.is_active boolean
plans.unit_price string (decimal)
plans.unit string
Enum: month, quarter, half_month, day, hour, quantity
plans.init_price number (double)
plans.switch_price number (double)
plans.backend_id string
plans.organization_groups array of objects
plans.organization_groups.uuid string (uuid)
plans.organization_groups.url string (uri)
plans.organization_groups.name string
plans.organization_groups.parent_uuid string (uuid) UUID of the parent organization group
plans.organization_groups.parent_name string Name of the parent organization group
plans.organization_groups.parent string (uri)
plans.organization_groups.customers_count integer Number of customers in this organization group
plans.components array of objects
plans.components.type string Unique internal name of the measured unit, for example floating_ip.
plans.components.name string Display name for the measured unit, for example, Floating IP.
plans.components.measured_unit string Unit of measurement, for example, GB.
plans.components.amount integer
plans.components.price string (decimal)
plans.components.future_price string (decimal)
plans.components.discount_threshold integer Minimum amount to be eligible for discount.
plans.components.discount_rate integer Discount rate in percentage.
plans.prices object (free-form)
plans.future_prices object (free-form)
plans.quotas object (free-form)
plans.resources_count integer
plans.plan_type string
plans.minimal_price number (double)
options any Fields describing resource provision form.
resource_options any Fields describing resource report form.
secret_options any
thumbnail string (uri)

List project permissions of a service provider

Returns a paginated list of project permissions for all projects that have consumed resources from the specified service provider.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-service-providers/a1b2c3d4-e5f6-7890-abcd-ef1234567890/project_permissions/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.offering_permission_o_enum import OfferingPermissionOEnum # (1)
from waldur_api_client.models.project_permission_log_field_enum import ProjectPermissionLogFieldEnum # (2)
from waldur_api_client.api.marketplace_service_providers import marketplace_service_providers_project_permissions_list # (3)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_service_providers_project_permissions_list.sync(
    service_provider_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

for item in response:
    print(item)
  1. Model Source: OfferingPermissionOEnum
  2. Model Source: ProjectPermissionLogFieldEnum
  3. API Source: marketplace_service_providers_project_permissions_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceServiceProvidersProjectPermissionsList } from 'waldur-js-client';

try {
  const response = await marketplaceServiceProvidersProjectPermissionsList({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "service_provider_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
service_provider_uuid string (uuid) ✓
Name Type Description
created string (date-time) Created after
expiration_time string (date-time)
field array
full_name string User full name contains
modified string (date-time) Modified after
native_name string
o array Ordering
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
role_name string Role name contains
role_uuid string (uuid) Role UUID
scope_name string Scope name
scope_type string Scope type
scope_uuid string Scope UUID
user string (uuid)
user_slug string User slug contains
user_url string (uri)
username string

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
created string (date-time)
expiration_time string (date-time)
created_by string (uri)
created_by_full_name string
created_by_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
project string (uri)
project_uuid string (uuid)
project_name string
project_created string (date-time)
project_end_date string (date-time)
customer_uuid string (uuid)
customer_name string
role string
role_name string
user string (uri)
user_full_name string
user_native_name string
user_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
user_uuid string (uuid)
user_email string (email)

List project service accounts for a service provider

Returns a paginated list of project service accounts that have access to resources managed by the provider.

1
2
3
    This includes:
    - Projects with active resources of the service provider.
    - Service accounts with non-blank usernames.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-service-providers/a1b2c3d4-e5f6-7890-abcd-ef1234567890/project_service_accounts/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.service_account_state import ServiceAccountState # (1)
from waldur_api_client.api.marketplace_service_providers import marketplace_service_providers_project_service_accounts_list # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_service_providers_project_service_accounts_list.sync(
    service_provider_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

for item in response:
    print(item)
  1. Model Source: ServiceAccountState
  2. API Source: marketplace_service_providers_project_service_accounts_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceServiceProvidersProjectServiceAccountsList } from 'waldur-js-client';

try {
  const response = await marketplaceServiceProvidersProjectServiceAccountsList({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "service_provider_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
service_provider_uuid string (uuid) ✓
Name Type Description
email string Email contains
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
project string (uri) Project URL
project_uuid string (uuid) Project UUID
state array Service account state
username string Username

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
url string (uri)
uuid string (uuid)
created string (date-time)
modified string (date-time)
username string
description string
error_message string
error_traceback string
state any
token string
email string (email)
expires_at string
preferred_identifier string
project string (uuid)
project_uuid string (uuid)
project_name string
customer_uuid string (uuid)
customer_name string
customer_abbreviation string

List projects of a service provider

Returns a paginated list of all projects that have consumed resources from the specified service provider.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-service-providers/a1b2c3d4-e5f6-7890-abcd-ef1234567890/projects/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.marketplace_provider_customer_project_o_enum import MarketplaceProviderCustomerProjectOEnum # (1)
from waldur_api_client.models.project_field_enum import ProjectFieldEnum # (2)
from waldur_api_client.api.marketplace_service_providers import marketplace_service_providers_projects_list # (3)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_service_providers_projects_list.sync(
    service_provider_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

for item in response:
    print(item)
  1. Model Source: MarketplaceProviderCustomerProjectOEnum
  2. Model Source: ProjectFieldEnum
  3. API Source: marketplace_service_providers_projects_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceServiceProvidersProjectsList } from 'waldur-js-client';

try {
  const response = await marketplaceServiceProvidersProjectsList({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "service_provider_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
service_provider_uuid string (uuid) ✓
Name Type Description
backend_id string
can_admin boolean Return a list of projects where current user is admin.
can_manage boolean Return a list of projects where current user is manager or a customer owner.
conceal_finished_projects boolean Conceal finished projects
created string (date-time) Created after
customer array Multiple values may be separated by commas.
customer_abbreviation string Customer abbreviation
customer_name string Customer name
customer_native_name string Customer native name
description string Description
field array
is_removed boolean Is removed
modified string (date-time) Modified after
name string Name
name_exact string Name (exact)
o array Ordering
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
query string Filter by name, slug, UUID, backend ID or resource effective ID
slug string Slug

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
name string
slug string URL-friendly identifier. Only editable by staff users.
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_slug string
customer_native_name string
customer_abbreviation string
description string Project description (HTML content will be sanitized)
customer_display_billing_info_in_projects boolean
created string (date-time)
type string (uri)
type_name string
type_uuid string (uuid)
backend_id string
start_date string (date) Project start date. Cannot be edited after the start date has arrived.
end_date string (date) Project end date. Setting this field requires DELETE_PROJECT permission.
end_date_requested_by string (uri)
oecd_fos_2007_code any
oecd_fos_2007_label string Human-readable label for the OECD FOS 2007 classification code
is_industry boolean
image string (uri)
resources_count integer Number of active resources in this project
max_service_accounts integer Maximum number of service accounts allowed
kind any
is_removed boolean
termination_metadata any Metadata about project termination (read-only)
staff_notes string Internal notes visible only to staff and support users (HTML content will be sanitized)
grace_period_days integer Number of extra days after project end date before resources are terminated. Overrides customer-level setting.
user_email_patterns any
user_affiliations any
user_identity_sources any List of allowed identity sources (identity providers).
project_credit number (double)
marketplace_resource_count object (free-form)
billing_price_estimate any

Retrieve a service provider

Returns details of a specific service provider.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-service-providers/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.service_provider_field_enum import ServiceProviderFieldEnum # (1)
from waldur_api_client.api.marketplace_service_providers import marketplace_service_providers_retrieve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_service_providers_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. Model Source: ServiceProviderFieldEnum
  2. API Source: marketplace_service_providers_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceServiceProvidersRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceServiceProvidersRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type
field array

200 -

Field Type Description
url string (uri)
uuid string (uuid)
created string (date-time)
description string
enable_notifications boolean
customer string (uri)
customer_name string
customer_uuid string (uuid)
customer_image string (uri)
customer_abbreviation string
customer_slug string
customer_native_name string
customer_country string
image string (uri)
organization_groups array of objects
organization_groups.uuid string (uuid)
organization_groups.url string (uri)
organization_groups.name string
organization_groups.parent_uuid string (uuid) UUID of the parent organization group
organization_groups.parent_name string Name of the parent organization group
organization_groups.parent string (uri)
organization_groups.customers_count integer Number of customers in this organization group
offering_count integer

Get service provider revenue

Returns monthly revenue data for the last year for the service provider.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-service-providers/a1b2c3d4-e5f6-7890-abcd-ef1234567890/revenue/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_service_providers import marketplace_service_providers_revenue_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_service_providers_revenue_list.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

for item in response:
    print(item)
  1. API Source: marketplace_service_providers_revenue_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceServiceProvidersRevenueList } from 'waldur-js-client';

try {
  const response = await marketplaceServiceProvidersRevenueList({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
total integer Total revenue amount
year integer Invoice year
month integer Invoice month

List customers with robot accounts

Returns a paginated list of customers who have robot accounts for resources managed by this service provider.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-service-providers/a1b2c3d4-e5f6-7890-abcd-ef1234567890/robot_account_customers/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_service_providers import marketplace_service_providers_robot_account_customers_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_service_providers_robot_account_customers_list.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

for item in response:
    print(item)
  1. API Source: marketplace_service_providers_robot_account_customers_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceServiceProvidersRobotAccountCustomersList } from 'waldur-js-client';

try {
  const response = await marketplaceServiceProvidersRobotAccountCustomersList({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type Description
customer_name string Filter by customer name (case-insensitive partial match).
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
name string Name of the entity
uuid string (uuid) UUID of the entity

List projects with robot accounts

Returns a paginated list of projects which have robot accounts for resources managed by this service provider.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-service-providers/a1b2c3d4-e5f6-7890-abcd-ef1234567890/robot_account_projects/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_service_providers import marketplace_service_providers_robot_account_projects_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_service_providers_robot_account_projects_list.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

for item in response:
    print(item)
  1. API Source: marketplace_service_providers_robot_account_projects_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceServiceProvidersRobotAccountProjectsList } from 'waldur-js-client';

try {
  const response = await marketplaceServiceProvidersRobotAccountProjectsList({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
project_name string Filter by project name (case-insensitive partial match).

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
name string Name of the entity
uuid string (uuid) UUID of the entity

Get service provider statistics

Returns various statistics for the service provider, such as number of active campaigns, customers, and resources.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-service-providers/a1b2c3d4-e5f6-7890-abcd-ef1234567890/stat/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_service_providers import marketplace_service_providers_stat_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_service_providers_stat_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_service_providers_stat_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceServiceProvidersStatRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceServiceProvidersStatRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
active_campaigns integer Number of active campaigns
current_customers integer Number of current customers
customers_number_change integer Change in number of customers
active_resources integer Number of active resources
resources_number_change integer Change in number of resources
active_and_paused_offerings integer Number of active and paused offerings
unresolved_tickets integer Number of unresolved support tickets
pending_orders integer Number of pending orders
erred_resources integer Number of resources in error state

List customers of a specific user within a service provider's scope

Returns a paginated list of customers that a specified user has access to within the scope of a service provider.

1
2
3
4
    This includes:
    - Customers where the user has direct permissions.
    - Customers with projects where the user has project roles.
    - Customers related to the service provider's resources that the user can access.

1
2
3
4
5
http \
  GET \
  https://api.example.com/api/marketplace-service-providers/a1b2c3d4-e5f6-7890-abcd-ef1234567890/user_customers/ \
  Authorization:"Token YOUR_API_TOKEN" \
  user_uuid=="a1b2c3d4-e5f6-7890-abcd-ef1234567890"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.marketplace_provider_customer_field_enum import MarketplaceProviderCustomerFieldEnum # (1)
from waldur_api_client.api.marketplace_service_providers import marketplace_service_providers_user_customers_list # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_service_providers_user_customers_list.sync(
    service_provider_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    user_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
)

for item in response:
    print(item)
  1. Model Source: MarketplaceProviderCustomerFieldEnum
  2. API Source: marketplace_service_providers_user_customers_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { marketplaceServiceProvidersUserCustomersList } from 'waldur-js-client';

try {
  const response = await marketplaceServiceProvidersUserCustomersList({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "service_provider_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  query: {
    "user_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
service_provider_uuid string (uuid) ✓
Name Type Required Description
abbreviation string Abbreviation
agreement_number string
archived boolean
backend_id string
contact_details string Contact details
current_user_has_project_create_permission boolean Return a list of customers where current user has project create permission.
field array
name string Name
name_exact string Name (exact)
native_name string Native name
organization_group_name string Organization group name
organization_group_uuid array Organization group UUID
owned_by_current_user boolean Return a list of customers where current user is owner.
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
query string Filter by name, native name, abbreviation, domain, UUID, registration code or agreement number
registration_code string
user_uuid string (uuid) ✓ UUID of the user to get related customers for.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
uuid string (uuid)
name string
slug string
abbreviation string
phone_number string
email string (email)
payment_profiles array of objects
payment_profiles.uuid string (uuid)
payment_profiles.url string (uri)
payment_profiles.name string
payment_profiles.organization_uuid string (uuid)
payment_profiles.organization string (uri)
payment_profiles.attributes object
payment_profiles.attributes.end_date string
payment_profiles.attributes.agreement_number string
payment_profiles.attributes.contract_sum integer
payment_profiles.payment_type string
payment_profiles.payment_type_display string
payment_profiles.is_active boolean
billing_price_estimate any
projects_count integer
users_count integer
projects array of objects
projects.uuid string (uuid)
projects.name string
projects.image string (uri)
users array of objects
users.uuid string (uuid)
users.full_name string
users.email string (email)
users.image string (uri)

List users of a service provider

Returns a paginated list of all users who have consumed resources from the specified service provider.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-service-providers/a1b2c3d4-e5f6-7890-abcd-ef1234567890/users/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.marketplace_service_provider_user_field_enum import MarketplaceServiceProviderUserFieldEnum # (1)
from waldur_api_client.models.marketplace_service_provider_user_o_enum import MarketplaceServiceProviderUserOEnum # (2)
from waldur_api_client.api.marketplace_service_providers import marketplace_service_providers_users_list # (3)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_service_providers_users_list.sync(
    service_provider_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

for item in response:
    print(item)
  1. Model Source: MarketplaceServiceProviderUserFieldEnum
  2. Model Source: MarketplaceServiceProviderUserOEnum
  3. API Source: marketplace_service_providers_users_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceServiceProvidersUsersList } from 'waldur-js-client';

try {
  const response = await marketplaceServiceProvidersUsersList({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "service_provider_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
service_provider_uuid string (uuid) ✓
Name Type Description
agreement_date string (date-time) Agreement date after
civil_number string
customer_uuid string (uuid) Customer UUID
date_joined string (date-time) Date joined after
description string
email string Email
field array
full_name string Full name
is_active boolean Is active
is_staff boolean Is staff
is_support boolean Is support
job_title string Job title
modified string (date-time) Date modified after
native_name string Native name
o array Ordering
organization string Organization
organization_roles string Organization roles
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
phone_number string
project_roles string Project roles
project_uuid string (uuid) Project UUID
query string Filter by first name, last name, civil number, username or email
registration_method string
user_keyword string User keyword
username string Username (exact)
username_list string Comma-separated usernames

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid)
username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
full_name string
first_name string
last_name string
organization string
email string (email)
phone_number string
projects_count integer
registration_method string Indicates what registration method was used.
affiliations any Person's affiliation within organization such as student, faculty, staff.
is_active boolean Designates whether this user should be treated as active. Unselect this instead of deleting accounts.
job_title string
gender any ISO 5218 gender code
personal_title string Honorific title (Mr, Ms, Dr, Prof, etc.)
place_of_birth string
country_of_residence string
nationality string Primary citizenship (ISO 3166-1 alpha-2 code)
nationalities any List of all citizenships (ISO 3166-1 alpha-2 codes)
organization_country string
organization_type string SCHAC URN (e.g., urn:schac:homeOrganizationType:int:university)
organization_registry_code string Company registration code of the user's organization, if known
eduperson_assurance any REFEDS assurance profile URIs from identity provider
civil_number string
birth_date string (date)
identity_source string Indicates what identity provider was used.
active_isds any List of ISDs that have asserted this user exists. User is deactivated when this becomes empty.

Get service provider API secret code

Returns the API secret code for a service provider. Requires service provider owner permission.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-service-providers/a1b2c3d4-e5f6-7890-abcd-ef1234567890/api_secret_code/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_service_providers import service_provider_api_secret_code_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = service_provider_api_secret_code_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: service_provider_api_secret_code_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { serviceProviderApiSecretCodeRetrieve } from 'waldur-js-client';

try {
  const response = await serviceProviderApiSecretCodeRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
api_secret_code string API secret code for authenticating service provider requests

Get summary of compliance checklists

Returns a summary of all compliance checklists used by this service provider with usage counts.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-service-providers/a1b2c3d4-e5f6-7890-abcd-ef1234567890/compliance/checklists_summary/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_service_providers import service_provider_checklists_summary # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = service_provider_checklists_summary.sync(
    service_provider_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

for item in response:
    print(item)
  1. API Source: service_provider_checklists_summary
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { serviceProviderChecklistsSummary } from 'waldur-js-client';

try {
  const response = await serviceProviderChecklistsSummary({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "service_provider_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
service_provider_uuid string (uuid) ✓
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
checklist_uuid string (uuid)
checklist_name string
questions_count integer
offerings_count integer

Get compliance overview for a service provider

Returns compliance overview statistics for all offerings managed by this service provider.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-service-providers/a1b2c3d4-e5f6-7890-abcd-ef1234567890/compliance/compliance_overview/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_service_providers import service_provider_compliance_overview # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = service_provider_compliance_overview.sync(
    service_provider_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

for item in response:
    print(item)
  1. API Source: service_provider_compliance_overview
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { serviceProviderComplianceOverview } from 'waldur-js-client';

try {
  const response = await serviceProviderComplianceOverview({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "service_provider_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
service_provider_uuid string (uuid) ✓
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
offering_uuid string (uuid)
offering_name string
checklist_name string
total_users integer
users_with_completions integer
completed_users integer
pending_users integer
compliance_rate number (double)

List offering users' compliance status

Returns a list of offering users with their compliance status for this service provider. Can be filtered by offering and compliance status.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-service-providers/a1b2c3d4-e5f6-7890-abcd-ef1234567890/compliance/offering_users/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_service_providers import service_provider_offering_users_compliance # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = service_provider_offering_users_compliance.sync(
    service_provider_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

for item in response:
    print(item)
  1. API Source: service_provider_offering_users_compliance
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { serviceProviderOfferingUsersCompliance } from 'waldur-js-client';

try {
  const response = await serviceProviderOfferingUsersCompliance({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "service_provider_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
service_provider_uuid string (uuid) ✓
Name Type Description
compliance_status string Filter by compliance status: completed, pending, no_checklist.
offering_uuid string (uuid) Filter by offering UUID.
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
uuid string (uuid)
user_full_name string
user_email string
offering_name string
checklist_name string
username string
state any
completion_percentage integer
compliance_status string
last_updated string (date-time)
created string (date-time)

Grant a role to a user

Assigns a specific role to a user within the current scope. An optional expiration time for the role can be set.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/marketplace-service-providers/a1b2c3d4-e5f6-7890-abcd-ef1234567890/add_user/ \
  Authorization:"Token YOUR_API_TOKEN" \
  role="string-value" \
  user="a1b2c3d4-e5f6-7890-abcd-ef1234567890"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.user_role_create_request import UserRoleCreateRequest # (1)
from waldur_api_client.api.marketplace_service_providers import marketplace_service_providers_add_user # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = UserRoleCreateRequest(
    role="string-value",
    user="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
)
response = marketplace_service_providers_add_user.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: UserRoleCreateRequest
  2. API Source: marketplace_service_providers_add_user
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { marketplaceServiceProvidersAddUser } from 'waldur-js-client';

try {
  const response = await marketplaceServiceProvidersAddUser({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "role": "string-value",
    "user": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
role string ✓
user string (uuid) ✓
expiration_time string (date-time)

201 -

Field Type
expiration_time string (date-time)

400 - Validation error, for example when trying to add a user to a terminated project.

Create a service provider

Creates a new service provider profile for a customer.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/marketplace-service-providers/ \
  Authorization:"Token YOUR_API_TOKEN" \
  customer="https://api.example.com/api/customer/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.service_provider_request import ServiceProviderRequest # (1)
from waldur_api_client.api.marketplace_service_providers import marketplace_service_providers_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ServiceProviderRequest(
    customer="https://api.example.com/api/customer/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = marketplace_service_providers_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ServiceProviderRequest
  2. API Source: marketplace_service_providers_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceServiceProvidersCreate } from 'waldur-js-client';

try {
  const response = await marketplaceServiceProvidersCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "customer": "https://api.example.com/api/customer/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required
description string
enable_notifications boolean
customer string (uri) ✓
image string (binary)

201 -

Field Type Description
url string (uri)
uuid string (uuid)
created string (date-time)
description string
enable_notifications boolean
customer string (uri)
customer_name string
customer_uuid string (uuid)
customer_image string (uri)
customer_abbreviation string
customer_slug string
customer_native_name string
customer_country string
image string (uri)
organization_groups array of objects
organization_groups.uuid string (uuid)
organization_groups.url string (uri)
organization_groups.name string
organization_groups.parent_uuid string (uuid) UUID of the parent organization group
organization_groups.parent_name string Name of the parent organization group
organization_groups.parent string (uri)
organization_groups.customers_count integer Number of customers in this organization group
offering_count integer

Revoke a role from a user

Removes a specific role from a user within the current scope. This effectively revokes their permissions associated with that role.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/marketplace-service-providers/a1b2c3d4-e5f6-7890-abcd-ef1234567890/delete_user/ \
  Authorization:"Token YOUR_API_TOKEN" \
  role="string-value" \
  user="a1b2c3d4-e5f6-7890-abcd-ef1234567890"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.user_role_delete_request import UserRoleDeleteRequest # (1)
from waldur_api_client.api.marketplace_service_providers import marketplace_service_providers_delete_user # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = UserRoleDeleteRequest(
    role="string-value",
    user="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
)
response = marketplace_service_providers_delete_user.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: UserRoleDeleteRequest
  2. API Source: marketplace_service_providers_delete_user
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { marketplaceServiceProvidersDeleteUser } from 'waldur-js-client';

try {
  const response = await marketplaceServiceProvidersDeleteUser({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "role": "string-value",
    "user": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
role string ✓
user string (uuid) ✓
expiration_time string (date-time)

200 - Role revoked successfully.

Generate site agent configuration

Generates a YAML configuration file for waldur-site-agent based on selected SLURM offerings. The configuration includes offering details, components, backend settings, and optionally SLURM periodic usage policy settings. Secrets are shown as placeholders that need to be filled in.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/marketplace-service-providers/a1b2c3d4-e5f6-7890-abcd-ef1234567890/generate_site_agent_config/ \
  Authorization:"Token YOUR_API_TOKEN" \
  offering_uuids:='[]'

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.site_agent_config_generation_request import SiteAgentConfigGenerationRequest # (1)
from waldur_api_client.api.marketplace_service_providers import marketplace_service_providers_generate_site_agent_config # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = SiteAgentConfigGenerationRequest(
    offering_uuids=[]
)
response = marketplace_service_providers_generate_site_agent_config.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: SiteAgentConfigGenerationRequest
  2. API Source: marketplace_service_providers_generate_site_agent_config
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { marketplaceServiceProvidersGenerateSiteAgentConfig } from 'waldur-js-client';

try {
  const response = await marketplaceServiceProvidersGenerateSiteAgentConfig({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "offering_uuids": []
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
offering_uuids array of string (uuid)s ✓ List of SLURM offering UUIDs to include in configuration
include_policy_settings boolean Include SLURM periodic usage policy settings in configuration
Constraints: default: True
waldur_api_url string (uri) Waldur API URL (defaults to current server URL)
timezone string Timezone for the site agent
Constraints: default: UTC

200 -

Set offering username for a user

Sets or updates the offering-specific username for a user across all offerings managed by the service provider that the user has access to.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/marketplace-service-providers/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_offerings_username/ \
  Authorization:"Token YOUR_API_TOKEN" \
  user_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  username="alice"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.set_offerings_username_request import SetOfferingsUsernameRequest # (1)
from waldur_api_client.api.marketplace_service_providers import marketplace_service_providers_set_offerings_username # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = SetOfferingsUsernameRequest(
    user_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    username="alice"
)
response = marketplace_service_providers_set_offerings_username.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: SetOfferingsUsernameRequest
  2. API Source: marketplace_service_providers_set_offerings_username
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { marketplaceServiceProvidersSetOfferingsUsername } from 'waldur-js-client';

try {
  const response = await marketplaceServiceProvidersSetOfferingsUsername({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "user_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "username": "alice"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
user_uuid string (uuid) ✓ UUID of the user
username string ✓ Username for offering access

201 - No response body

Update a user's role expiration

Updates the expiration time for a user's existing role in the current scope. This is useful for extending or shortening the duration of a permission. To make a role permanent, set expiration_time to null.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/marketplace-service-providers/a1b2c3d4-e5f6-7890-abcd-ef1234567890/update_user/ \
  Authorization:"Token YOUR_API_TOKEN" \
  role="string-value" \
  user="a1b2c3d4-e5f6-7890-abcd-ef1234567890"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.user_role_update_request import UserRoleUpdateRequest # (1)
from waldur_api_client.api.marketplace_service_providers import marketplace_service_providers_update_user # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = UserRoleUpdateRequest(
    role="string-value",
    user="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
)
response = marketplace_service_providers_update_user.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: UserRoleUpdateRequest
  2. API Source: marketplace_service_providers_update_user
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { marketplaceServiceProvidersUpdateUser } from 'waldur-js-client';

try {
  const response = await marketplaceServiceProvidersUpdateUser({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "role": "string-value",
    "user": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
role string ✓
user string (uuid) ✓
expiration_time string (date-time)

200 -

Field Type
expiration_time string (date-time)

Generate new service provider API secret code

Generates a new API secret code for a service provider, invalidating the old one. Requires service provider owner permission.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-service-providers/a1b2c3d4-e5f6-7890-abcd-ef1234567890/api_secret_code/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_service_providers import service_provider_api_secret_code_generate # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = service_provider_api_secret_code_generate.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: service_provider_api_secret_code_generate
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { serviceProviderApiSecretCodeGenerate } from 'waldur-js-client';

try {
  const response = await serviceProviderApiSecretCodeGenerate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
api_secret_code string API secret code for authenticating service provider requests

Update a service provider

Updates an existing service provider profile.

1
2
3
4
5
http \
  PUT \
  https://api.example.com/api/marketplace-service-providers/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  customer="https://api.example.com/api/customer/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.service_provider_request import ServiceProviderRequest # (1)
from waldur_api_client.api.marketplace_service_providers import marketplace_service_providers_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ServiceProviderRequest(
    customer="https://api.example.com/api/customer/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = marketplace_service_providers_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ServiceProviderRequest
  2. API Source: marketplace_service_providers_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { marketplaceServiceProvidersUpdate } from 'waldur-js-client';

try {
  const response = await marketplaceServiceProvidersUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "customer": "https://api.example.com/api/customer/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
description string
enable_notifications boolean
customer string (uri) ✓
image string (binary)

200 -

Field Type Description
url string (uri)
uuid string (uuid)
created string (date-time)
description string
enable_notifications boolean
customer string (uri)
customer_name string
customer_uuid string (uuid)
customer_image string (uri)
customer_abbreviation string
customer_slug string
customer_native_name string
customer_country string
image string (uri)
organization_groups array of objects
organization_groups.uuid string (uuid)
organization_groups.url string (uri)
organization_groups.name string
organization_groups.parent_uuid string (uuid) UUID of the parent organization group
organization_groups.parent_name string Name of the parent organization group
organization_groups.parent string (uri)
organization_groups.customers_count integer Number of customers in this organization group
offering_count integer

Partially update a service provider

Partially updates an existing service provider profile.

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/marketplace-service-providers/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_service_provider_request import PatchedServiceProviderRequest # (1)
from waldur_api_client.api.marketplace_service_providers import marketplace_service_providers_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedServiceProviderRequest()
response = marketplace_service_providers_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedServiceProviderRequest
  2. API Source: marketplace_service_providers_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceServiceProvidersPartialUpdate } from 'waldur-js-client';

try {
  const response = await marketplaceServiceProvidersPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
description string
enable_notifications boolean
image string (binary)

200 -

Field Type Description
url string (uri)
uuid string (uuid)
created string (date-time)
description string
enable_notifications boolean
customer string (uri)
customer_name string
customer_uuid string (uuid)
customer_image string (uri)
customer_abbreviation string
customer_slug string
customer_native_name string
customer_country string
image string (uri)
organization_groups array of objects
organization_groups.uuid string (uuid)
organization_groups.url string (uri)
organization_groups.name string
organization_groups.parent_uuid string (uuid) UUID of the parent organization group
organization_groups.parent_name string Name of the parent organization group
organization_groups.parent string (uri)
organization_groups.customers_count integer Number of customers in this organization group
offering_count integer

Delete a service provider

Deletes a service provider profile. Only possible if there are no active offerings.

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/marketplace-service-providers/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_service_providers import marketplace_service_providers_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_service_providers_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_service_providers_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceServiceProvidersDestroy } from 'waldur-js-client';

try {
  const response = await marketplaceServiceProvidersDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Resources and orders

Marketplace Orders

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/marketplace-orders/ List orders
GET /api/marketplace-orders/{uuid}/ Retrieve an order
POST /api/marketplace-orders/ Create an order
POST /api/marketplace-orders/{uuid}/unlink/ Unlink an order (staff only)
DELETE /api/marketplace-orders/{uuid}/ Delete a pending order
State Management
POST /api/marketplace-orders/{uuid}/approve_by_consumer/ Approve an order (consumer)
POST /api/marketplace-orders/{uuid}/approve_by_provider/ Approve an order (provider)
POST /api/marketplace-orders/{uuid}/cancel/ Cancel an order
POST /api/marketplace-orders/{uuid}/reject_by_consumer/ Reject an order (consumer)
POST /api/marketplace-orders/{uuid}/reject_by_provider/ Reject an order (provider)
POST /api/marketplace-orders/{uuid}/set_state_done/ Set order state to done (agent)
POST /api/marketplace-orders/{uuid}/set_state_erred/ Set order state to erred (agent)
POST /api/marketplace-orders/{uuid}/set_state_executing/ Set order state to executing (agent)
Configuration & Updates
POST /api/marketplace-orders/{uuid}/delete_attachment/ Delete order attachment
POST /api/marketplace-orders/{uuid}/set_backend_id/ Set order backend ID
POST /api/marketplace-orders/{uuid}/update_attachment/ Update order attachment
Data & Reporting
GET /api/marketplace-orders/{uuid}/offering/ Get offering details
Other Actions
POST /api/marketplace-orders/{uuid}/set_consumer_info/ Set consumer info on order
POST /api/marketplace-orders/{uuid}/set_provider_info/ Set provider info on order
PUT /api/marketplace-orders/{uuid}/ Update
PATCH /api/marketplace-orders/{uuid}/ Partial Update

Core CRUD

List orders

Returns a paginated list of orders accessible to the current user. Orders are visible to service consumers (project/customer members with appropriate permissions) and service providers.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-orders/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.order_details_field_enum import OrderDetailsFieldEnum # (1)
from waldur_api_client.models.order_details_o_enum import OrderDetailsOEnum # (2)
from waldur_api_client.models.order_state import OrderState # (3)
from waldur_api_client.models.request_types import RequestTypes # (4)
from waldur_api_client.api.marketplace_orders import marketplace_orders_list # (5)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_orders_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: OrderDetailsFieldEnum
  2. Model Source: OrderDetailsOEnum
  3. Model Source: OrderState
  4. Model Source: RequestTypes
  5. API Source: marketplace_orders_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceOrdersList } from 'waldur-js-client';

try {
  const response = await marketplaceOrdersList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
can_approve_as_consumer boolean Can approve as consumer
can_approve_as_provider boolean Can approve as provider
category_uuid string (uuid) Category UUID
created string (date-time) Created after
customer_uuid string (uuid) Customer UUID
field array
modified string (date-time) Modified after
o array Ordering
offering string (uri)
offering_slug array Multiple values may be separated by commas.
offering_type array Offering type
offering_uuid string (uuid) Offering UUID
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
parent_offering_uuid string (uuid)
project_uuid string (uuid) Project UUID
provider_uuid string (uuid) Provider UUID
query string Search by order UUID, slug, project name or resource name
resource string (uri) Resource URL
resource_name string Resource name
resource_uuid string (uuid) Resource UUID
service_manager_uuid string (uuid) Service manager UUID
state array Order state
type array Order type

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
offering string (uri)
offering_name string
offering_uuid string (uuid)
offering_description string
offering_image string (uri)
offering_thumbnail string (uri)
offering_type string
offering_shared boolean Accessible to all customers.
offering_billable boolean Purchase and usage is invoiced.
offering_plugin_options any Public data used by specific plugin, such as storage mode for OpenStack.
provider_name string
provider_uuid string (uuid)
provider_slug string
category_title string
category_uuid string (uuid)
category_icon string (uri)
plan string (uri)
plan_unit any
plan_name string
plan_uuid string (uuid)
plan_description string
attributes any
limits object (free-form)
uuid string (uuid)
created string (date-time)
modified string (date-time)
resource_uuid string (uuid)
resource_type string
resource_name string
cost string (decimal)
state any
output string
marketplace_resource_uuid string (uuid)
error_message string
error_traceback string
callback_url string (uri)
completed_at string (date-time)
request_comment string
attachment string (uri)
type any
start_date string (date) Enables delayed processing of resource provisioning order.
slug string
url string (uri)
consumer_reviewed_by string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
consumer_reviewed_by_full_name string
consumer_reviewed_by_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
consumer_reviewed_at string (date-time)
provider_reviewed_by string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
provider_reviewed_by_full_name string
provider_reviewed_by_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
provider_reviewed_at string (date-time)
created_by_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
created_by_full_name string
created_by_civil_number string
created_by_email string (email)
created_by_organization string
created_by_organization_registry_code string Company registration code of the user's organization, if known
customer_name string
customer_uuid string (uuid)
customer_slug string
project_name string
project_uuid string (uuid)
project_description string
project_slug string
old_plan_name string
new_plan_name string
old_plan_uuid string (uuid)
new_plan_uuid string (uuid)
old_cost_estimate number (double)
new_cost_estimate string (decimal)
can_terminate boolean
fixed_price number (double)
activation_price number (double)
termination_comment string
backend_id string
order_subtype string
provider_message string
provider_message_url string (uri)
provider_message_attachment string (uri)
consumer_message string
consumer_message_attachment string (uri)
consumer_rejection_comment string
provider_rejection_comment string
issue any

Retrieve an order

Returns the details of a specific order.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-orders/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.order_details_field_enum import OrderDetailsFieldEnum # (1)
from waldur_api_client.api.marketplace_orders import marketplace_orders_retrieve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_orders_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. Model Source: OrderDetailsFieldEnum
  2. API Source: marketplace_orders_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceOrdersRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceOrdersRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type
field array

200 -

Field Type Description
offering string (uri)
offering_name string
offering_uuid string (uuid)
offering_description string
offering_image string (uri)
offering_thumbnail string (uri)
offering_type string
offering_shared boolean Accessible to all customers.
offering_billable boolean Purchase and usage is invoiced.
offering_plugin_options any Public data used by specific plugin, such as storage mode for OpenStack.
provider_name string
provider_uuid string (uuid)
provider_slug string
category_title string
category_uuid string (uuid)
category_icon string (uri)
plan string (uri)
plan_unit any
plan_name string
plan_uuid string (uuid)
plan_description string
attributes any
limits object (free-form)
uuid string (uuid)
created string (date-time)
modified string (date-time)
resource_uuid string (uuid)
resource_type string
resource_name string
cost string (decimal)
state any
output string
marketplace_resource_uuid string (uuid)
error_message string
error_traceback string
callback_url string (uri)
completed_at string (date-time)
request_comment string
attachment string (uri)
type any
start_date string (date) Enables delayed processing of resource provisioning order.
slug string
url string (uri)
consumer_reviewed_by string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
consumer_reviewed_by_full_name string
consumer_reviewed_by_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
consumer_reviewed_at string (date-time)
provider_reviewed_by string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
provider_reviewed_by_full_name string
provider_reviewed_by_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
provider_reviewed_at string (date-time)
created_by_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
created_by_full_name string
created_by_civil_number string
created_by_email string (email)
created_by_organization string
created_by_organization_registry_code string Company registration code of the user's organization, if known
customer_name string
customer_uuid string (uuid)
customer_slug string
project_name string
project_uuid string (uuid)
project_description string
project_slug string
old_plan_name string
new_plan_name string
old_plan_uuid string (uuid)
new_plan_uuid string (uuid)
old_cost_estimate number (double)
new_cost_estimate string (decimal)
can_terminate boolean
fixed_price number (double)
activation_price number (double)
termination_comment string
backend_id string
order_subtype string
provider_message string
provider_message_url string (uri)
provider_message_attachment string (uri)
consumer_message string
consumer_message_attachment string (uri)
consumer_rejection_comment string
provider_rejection_comment string
issue any

Create an order

Creates a new order to provision a resource. The order will be placed in a pending state and may require approval depending on the offering and user permissions.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/marketplace-orders/ \
  Authorization:"Token YOUR_API_TOKEN" \
  offering="https://api.example.com/api/offering/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.order_create_request import OrderCreateRequest # (1)
from waldur_api_client.api.marketplace_orders import marketplace_orders_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OrderCreateRequest(
    offering="https://api.example.com/api/offering/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    project="https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = marketplace_orders_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OrderCreateRequest
  2. API Source: marketplace_orders_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { marketplaceOrdersCreate } from 'waldur-js-client';

try {
  const response = await marketplaceOrdersCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "offering": "https://api.example.com/api/offering/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "project": "https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
offering string (uri) ✓
plan string (uri)
attributes any Attributes structure depends on the offering type specified in the parent object. Can also be a generic object for offerings without a specific attributes schema.
limits object (free-form)
accepting_terms_of_service boolean
Constraints: write-only
callback_url string (uri)
request_comment string
type any
Constraints: default: Create
start_date string (date) Enables delayed processing of resource provisioning order.
slug string URL-friendly identifier. Only editable by staff users.
project string (uri) ✓

201 -

Field Type Description
offering string (uri)
offering_name string
offering_uuid string (uuid)
offering_description string
offering_image string (uri)
offering_thumbnail string (uri)
offering_type string
offering_shared boolean Accessible to all customers.
offering_billable boolean Purchase and usage is invoiced.
offering_plugin_options any Public data used by specific plugin, such as storage mode for OpenStack.
provider_name string
provider_uuid string (uuid)
provider_slug string
category_title string
category_uuid string (uuid)
category_icon string (uri)
plan string (uri)
plan_unit any
plan_name string
plan_uuid string (uuid)
plan_description string
attributes any
limits object (free-form)
uuid string (uuid)
created string (date-time)
modified string (date-time)
resource_uuid string (uuid)
resource_type string
resource_name string
cost string (decimal)
state any
output string
marketplace_resource_uuid string (uuid)
error_message string
error_traceback string
callback_url string (uri)
completed_at string (date-time)
request_comment string
attachment string (uri)
type any
start_date string (date) Enables delayed processing of resource provisioning order.
slug string
url string (uri)
consumer_reviewed_by string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
consumer_reviewed_by_full_name string
consumer_reviewed_by_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
consumer_reviewed_at string (date-time)
provider_reviewed_by string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
provider_reviewed_by_full_name string
provider_reviewed_by_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
provider_reviewed_at string (date-time)
created_by_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
created_by_full_name string
created_by_civil_number string
created_by_email string (email)
created_by_organization string
created_by_organization_registry_code string Company registration code of the user's organization, if known
customer_name string
customer_uuid string (uuid)
customer_slug string
project_name string
project_uuid string (uuid)
project_description string
project_slug string
old_plan_name string
new_plan_name string
old_plan_uuid string (uuid)
new_plan_uuid string (uuid)
old_cost_estimate number (double)
new_cost_estimate string (decimal)
can_terminate boolean
fixed_price number (double)
activation_price number (double)
termination_comment string
backend_id string
order_subtype string
provider_message string
provider_message_url string (uri)
provider_message_attachment string (uri)
consumer_message string
consumer_message_attachment string (uri)
consumer_rejection_comment string
provider_rejection_comment string
issue any

Forcefully deletes an order from the database without affecting the backend resource. This is a staff-only administrative action used to clean up stuck or invalid orders.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-orders/a1b2c3d4-e5f6-7890-abcd-ef1234567890/unlink/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_orders import marketplace_orders_unlink # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_orders_unlink.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_orders_unlink
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceOrdersUnlink } from 'waldur-js-client';

try {
  const response = await marketplaceOrdersUnlink({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

403 - No response body

Delete a pending order

Deletes an order that is still in a pending state (e.g., pending-consumer or pending-provider). Executing or completed orders cannot be deleted.

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/marketplace-orders/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_orders import marketplace_orders_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_orders_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_orders_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceOrdersDestroy } from 'waldur-js-client';

try {
  const response = await marketplaceOrdersDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

State Management

Approve an order (consumer)

Approves a pending order from the consumer's side (e.g., project manager, customer owner). This transitions the order to the next state, which could be pending provider approval or executing.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-orders/a1b2c3d4-e5f6-7890-abcd-ef1234567890/approve_by_consumer/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_orders import marketplace_orders_approve_by_consumer # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_orders_approve_by_consumer.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_orders_approve_by_consumer
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceOrdersApproveByConsumer } from 'waldur-js-client';

try {
  const response = await marketplaceOrdersApproveByConsumer({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
detail string

Approve an order (provider)

Approves a pending order from the provider's side. This typically transitions the order to the executing state.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-orders/a1b2c3d4-e5f6-7890-abcd-ef1234567890/approve_by_provider/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.order_approve_by_provider_request import OrderApproveByProviderRequest # (1)
from waldur_api_client.api.marketplace_orders import marketplace_orders_approve_by_provider # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OrderApproveByProviderRequest()
response = marketplace_orders_approve_by_provider.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OrderApproveByProviderRequest
  2. API Source: marketplace_orders_approve_by_provider
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceOrdersApproveByProvider } from 'waldur-js-client';

try {
  const response = await marketplaceOrdersApproveByProvider({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
attributes any

200 -

Field Type
detail string

Cancel an order

Cancels an order. This is typically only possible for certain offering types (e.g., basic support) and in specific states (pending or executing).

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-orders/a1b2c3d4-e5f6-7890-abcd-ef1234567890/cancel/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_orders import marketplace_orders_cancel # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_orders_cancel.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_orders_cancel
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceOrdersCancel } from 'waldur-js-client';

try {
  const response = await marketplaceOrdersCancel({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

202 - No response body

Reject an order (consumer)

Rejects a pending order from the consumer's side. This moves the order to the 'rejected' state.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-orders/a1b2c3d4-e5f6-7890-abcd-ef1234567890/reject_by_consumer/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.order_error_details_request import OrderErrorDetailsRequest # (1)
from waldur_api_client.api.marketplace_orders import marketplace_orders_reject_by_consumer # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OrderErrorDetailsRequest()
response = marketplace_orders_reject_by_consumer.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OrderErrorDetailsRequest
  2. API Source: marketplace_orders_reject_by_consumer
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceOrdersRejectByConsumer } from 'waldur-js-client';

try {
  const response = await marketplaceOrdersRejectByConsumer({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
error_message string
error_traceback string
consumer_rejection_comment string

200 - No response body

Reject an order (provider)

Rejects a pending order from the provider's side. This moves the order to the 'rejected' state.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-orders/a1b2c3d4-e5f6-7890-abcd-ef1234567890/reject_by_provider/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.order_provider_rejection_request import OrderProviderRejectionRequest # (1)
from waldur_api_client.api.marketplace_orders import marketplace_orders_reject_by_provider # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OrderProviderRejectionRequest()
response = marketplace_orders_reject_by_provider.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OrderProviderRejectionRequest
  2. API Source: marketplace_orders_reject_by_provider
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceOrdersRejectByProvider } from 'waldur-js-client';

try {
  const response = await marketplaceOrdersRejectByProvider({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
provider_rejection_comment string

200 - No response body

Set order state to done (agent)

Used by external agents (e.g., site agent) to manually transition the order state to 'done'. This is only applicable for specific offering types.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-orders/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_state_done/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_orders import marketplace_orders_set_state_done # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_orders_set_state_done.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_orders_set_state_done
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceOrdersSetStateDone } from 'waldur-js-client';

try {
  const response = await marketplaceOrdersSetStateDone({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 - No response body

Set order state to erred (agent)

Used by external agents to report a failure during order processing. An error message and traceback can be provided.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-orders/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_state_erred/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.order_error_details_request import OrderErrorDetailsRequest # (1)
from waldur_api_client.api.marketplace_orders import marketplace_orders_set_state_erred # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OrderErrorDetailsRequest()
response = marketplace_orders_set_state_erred.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OrderErrorDetailsRequest
  2. API Source: marketplace_orders_set_state_erred
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceOrdersSetStateErred } from 'waldur-js-client';

try {
  const response = await marketplaceOrdersSetStateErred({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
error_message string
error_traceback string
consumer_rejection_comment string

200 - No response body

Set order state to executing (agent)

Used by external agents (e.g., site agent) to manually transition the order state to 'executing'. This is only applicable for specific offering types.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-orders/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_state_executing/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_orders import marketplace_orders_set_state_executing # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_orders_set_state_executing.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_orders_set_state_executing
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceOrdersSetStateExecuting } from 'waldur-js-client';

try {
  const response = await marketplaceOrdersSetStateExecuting({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 - No response body

Configuration & Updates

Delete order attachment

Allows deleting an attachment from a pending order.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-orders/a1b2c3d4-e5f6-7890-abcd-ef1234567890/delete_attachment/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_orders import marketplace_orders_delete_attachment # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_orders_delete_attachment.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_orders_delete_attachment
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceOrdersDeleteAttachment } from 'waldur-js-client';

try {
  const response = await marketplaceOrdersDeleteAttachment({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Set order backend ID

Allows a service provider or staff to set or update the backend ID associated with an order. This is useful for linking the order to an external system's identifier.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/marketplace-orders/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_backend_id/ \
  Authorization:"Token YOUR_API_TOKEN" \
  backend_id="ext-a1b2c3d4"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.order_backend_id_request import OrderBackendIDRequest # (1)
from waldur_api_client.api.marketplace_orders import marketplace_orders_set_backend_id # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OrderBackendIDRequest(
    backend_id="ext-a1b2c3d4"
)
response = marketplace_orders_set_backend_id.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OrderBackendIDRequest
  2. API Source: marketplace_orders_set_backend_id
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { marketplaceOrdersSetBackendId } from 'waldur-js-client';

try {
  const response = await marketplaceOrdersSetBackendId({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "backend_id": "ext-a1b2c3d4"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
backend_id string ✓

200 -

Field Type
status string

Update order attachment

Allows uploading or replacing a file attachment (e.g., a purchase order) for a pending order.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-orders/a1b2c3d4-e5f6-7890-abcd-ef1234567890/update_attachment/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.order_attachment_request import OrderAttachmentRequest # (1)
from waldur_api_client.api.marketplace_orders import marketplace_orders_update_attachment # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OrderAttachmentRequest()
response = marketplace_orders_update_attachment.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OrderAttachmentRequest
  2. API Source: marketplace_orders_update_attachment
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceOrdersUpdateAttachment } from 'waldur-js-client';

try {
  const response = await marketplaceOrdersUpdateAttachment({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
attachment string (binary)

200 -

Field Type
attachment string (uri)

Data & Reporting

Get offering details

Returns details of the offering connected to the requested object.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-orders/a1b2c3d4-e5f6-7890-abcd-ef1234567890/offering/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_orders import marketplace_orders_offering_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_orders_offering_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_orders_offering_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceOrdersOfferingRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceOrdersOfferingRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
url string (uri)
uuid string (uuid)
created string (date-time)
name string
slug string URL-friendly identifier. Only editable by staff users.
description string
full_description string
privacy_policy_link string (uri)
access_url string (uri) Publicly accessible offering access URL
endpoints array of objects
endpoints.uuid string (uuid)
endpoints.name string
endpoints.url string URL of the access endpoint
software_catalogs array of objects
software_catalogs.uuid string (uuid)
software_catalogs.catalog any
software_catalogs.enabled_cpu_family any List of enabled CPU families: ['x86_64', 'aarch64']
software_catalogs.enabled_cpu_microarchitectures any List of enabled CPU microarchitectures: ['generic', 'zen3']
software_catalogs.package_count integer
software_catalogs.partition any
partitions array of objects
partitions.uuid string (uuid)
partitions.partition_name string Name of the SLURM partition
partitions.cpu_bind integer Default task binding policy (SLURM cpu_bind)
partitions.def_cpu_per_gpu integer Default CPUs allocated per GPU
partitions.max_cpus_per_node integer Maximum allocated CPUs per node
partitions.max_cpus_per_socket integer Maximum allocated CPUs per socket
partitions.def_mem_per_cpu integer (int64) Default memory per CPU in MB
partitions.def_mem_per_gpu integer (int64) Default memory per GPU in MB
partitions.def_mem_per_node integer (int64) Default memory per node in MB
partitions.max_mem_per_cpu integer (int64) Maximum memory per CPU in MB
partitions.max_mem_per_node integer (int64) Maximum memory per node in MB
partitions.default_time integer Default time limit in minutes
partitions.max_time integer Maximum time limit in minutes
partitions.grace_time integer Preemption grace time in seconds
partitions.max_nodes integer Maximum nodes per job
partitions.min_nodes integer Minimum nodes per job
partitions.exclusive_topo boolean Exclusive topology access required
partitions.exclusive_user boolean Exclusive user access required
partitions.priority_tier integer Priority tier for scheduling and preemption
partitions.qos string Quality of Service (QOS) name
partitions.req_resv boolean Require reservation for job allocation
roles array of objects
roles.uuid string (uuid)
roles.name string
roles.url string (uri)
customer string (uri)
customer_uuid string (uuid)
customer_name string
project string (uri)
project_uuid string (uuid)
project_name string
category string (uri)
category_uuid string (uuid)
category_title string
attributes object (free-form)
options any
resource_options any
components array of objects
components.uuid string (uuid)
components.billing_type string
Enum: fixed, usage, limit, one, few
components.type string Unique internal name of the measured unit, for example floating_ip.
components.name string Display name for the measured unit, for example, Floating IP.
components.description string
components.measured_unit string Unit of measurement, for example, GB.
components.unit_factor integer The conversion factor from backend units to measured_unit
components.limit_period any
components.limit_amount integer
components.article_code string
components.max_value integer
components.min_value integer
components.max_available_limit integer
components.is_boolean boolean
components.default_limit integer
components.factor integer
components.is_builtin boolean
components.is_prepaid boolean
components.overage_component string (uuid)
components.min_prepaid_duration integer
components.max_prepaid_duration integer
plugin_options any
state any
vendor_details string
getting_started string
integration_guide string
thumbnail string (uri)
order_count integer
plans array of objects
plans.url string (uri)
plans.uuid string (uuid)
plans.name string
plans.description string
plans.article_code string
plans.max_amount integer Maximum number of plans that could be active. Plan is disabled when maximum amount is reached.
plans.archived boolean Forbids creation of new resources.
plans.is_active boolean
plans.unit_price string (decimal)
plans.unit string
Enum: month, quarter, half_month, day, hour, quantity
plans.init_price number (double)
plans.switch_price number (double)
plans.backend_id string
plans.organization_groups array of objects
plans.organization_groups.uuid string (uuid)
plans.organization_groups.url string (uri)
plans.organization_groups.name string
plans.organization_groups.parent_uuid string (uuid) UUID of the parent organization group
plans.organization_groups.parent_name string Name of the parent organization group
plans.organization_groups.parent string (uri)
plans.organization_groups.customers_count integer Number of customers in this organization group
plans.components array of objects
plans.components.type string Unique internal name of the measured unit, for example floating_ip.
plans.components.name string Display name for the measured unit, for example, Floating IP.
plans.components.measured_unit string Unit of measurement, for example, GB.
plans.components.amount integer
plans.components.price string (decimal)
plans.components.future_price string (decimal)
plans.components.discount_threshold integer Minimum amount to be eligible for discount.
plans.components.discount_rate integer Discount rate in percentage.
plans.prices object (free-form)
plans.future_prices object (free-form)
plans.quotas object (free-form)
plans.resources_count integer
plans.plan_type string
plans.minimal_price number (double)
screenshots array of objects
screenshots.name string
screenshots.uuid string (uuid)
screenshots.description string
screenshots.image string (uri)
screenshots.thumbnail string (uri)
screenshots.created string (date-time)
type string
shared boolean Accessible to all customers.
billable boolean Purchase and usage is invoiced.
scope string
scope_uuid string (uuid)
scope_name string (uuid)
scope_state any
scope_error_message string
files array of objects
files.name string
files.created string (date-time)
files.file string (uri)
quotas array of objects
quotas.name string
quotas.usage integer
quotas.limit integer
paused_reason string
datacite_doi string
citation_count integer Number of citations of a DOI
latitude number (double)
longitude number (double)
country any Country code (ISO 3166-1 alpha-2)
backend_id string
organization_groups array of objects
organization_groups.uuid string (uuid)
organization_groups.url string (uri)
organization_groups.name string
organization_groups.parent_uuid string (uuid) UUID of the parent organization group
organization_groups.parent_name string Name of the parent organization group
organization_groups.parent string (uri)
organization_groups.customers_count integer Number of customers in this organization group
tags array of objects
tags.uuid string (uuid)
tags.name string
image string (uri)
total_customers integer
total_cost integer
total_cost_estimated integer
parent_description string
parent_uuid string (uuid)
parent_name string
backend_metadata any
has_compliance_requirements boolean
billing_type_classification string Classify offering components by billing type. Returns 'limit_only', 'usage_only', or 'mixed'.
compliance_checklist string (uri)
user_has_consent boolean
is_accessible boolean
google_calendar_is_public boolean
google_calendar_link string Get the Google Calendar link for an offering.
promotion_campaigns array of objects
promotion_campaigns.uuid string (uuid)
promotion_campaigns.name string
promotion_campaigns.start_date string (date) Starting from this date, the campaign is active.
promotion_campaigns.end_date string (date) The last day the campaign is active.
promotion_campaigns.discount_type string
Enum: discount, special_price
promotion_campaigns.discount integer
promotion_campaigns.stock integer
promotion_campaigns.description string
promotion_campaigns.months integer How many months in a row should the related service (when activated) get special deal (0 for indefinitely until active)
promotion_campaigns.service_provider string (uri)

Other Actions

Set consumer info on order

Allows a consumer to respond to a provider's message with an optional message and file attachment on a pending order.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-orders/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_consumer_info/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.order_consumer_info_request import OrderConsumerInfoRequest # (1)
from waldur_api_client.api.marketplace_orders import marketplace_orders_set_consumer_info # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OrderConsumerInfoRequest()
response = marketplace_orders_set_consumer_info.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OrderConsumerInfoRequest
  2. API Source: marketplace_orders_set_consumer_info
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceOrdersSetConsumerInfo } from 'waldur-js-client';

try {
  const response = await marketplaceOrdersSetConsumerInfo({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
consumer_message string
consumer_message_attachment string (binary)

200 -

Field Type
detail string

Set provider info on order

Allows a service provider to send a message with an optional URL and file attachment to the consumer on a pending order.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-orders/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_provider_info/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.order_provider_info_request import OrderProviderInfoRequest # (1)
from waldur_api_client.api.marketplace_orders import marketplace_orders_set_provider_info # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OrderProviderInfoRequest()
response = marketplace_orders_set_provider_info.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OrderProviderInfoRequest
  2. API Source: marketplace_orders_set_provider_info
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceOrdersSetProviderInfo } from 'waldur-js-client';

try {
  const response = await marketplaceOrdersSetProviderInfo({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
provider_message string
provider_message_url string (uri)
provider_message_attachment string (binary)

200 -

Field Type
detail string

Update

1
2
3
4
http \
  PUT \
  https://api.example.com/api/marketplace-orders/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.order_update_request import OrderUpdateRequest # (1)
from waldur_api_client.api.marketplace_orders import marketplace_orders_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OrderUpdateRequest()
response = marketplace_orders_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OrderUpdateRequest
  2. API Source: marketplace_orders_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceOrdersUpdate } from 'waldur-js-client';

try {
  const response = await marketplaceOrdersUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
limits object (free-form)
attributes any
start_date string (date) Enables delayed processing of resource provisioning order.

200 -

Field Type Description
limits object (free-form)
attributes any
start_date string (date) Enables delayed processing of resource provisioning order.

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/marketplace-orders/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_order_update_request import PatchedOrderUpdateRequest # (1)
from waldur_api_client.api.marketplace_orders import marketplace_orders_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedOrderUpdateRequest()
response = marketplace_orders_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedOrderUpdateRequest
  2. API Source: marketplace_orders_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceOrdersPartialUpdate } from 'waldur-js-client';

try {
  const response = await marketplaceOrdersPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
limits object (free-form)
attributes any
start_date string (date) Enables delayed processing of resource provisioning order.

200 -

Field Type Description
limits object (free-form)
attributes any
start_date string (date) Enables delayed processing of resource provisioning order.

Marketplace Resources

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/marketplace-resources/ List consumer resources
GET /api/marketplace-resources/{uuid}/ Retrieve a consumer resource
POST /api/marketplace-resources/{uuid}/pull/ Pull resource data
POST /api/marketplace-resources/{uuid}/unlink/ Unlink a resource (staff only)
PUT /api/marketplace-resources/{uuid}/ Update a consumer resource
PATCH /api/marketplace-resources/{uuid}/ Partially update a consumer resource
State Management
POST /api/marketplace-resources/{uuid}/set_downscaled/ Set downscaled flag for resource
POST /api/marketplace-resources/{uuid}/set_paused/ Set paused flag for resource
POST /api/marketplace-resources/{uuid}/terminate/ Terminate a resource
Configuration & Updates
POST /api/marketplace-resources/{uuid}/move_resource/ Move a resource to another project
POST /api/marketplace-resources/{uuid}/renew/ Renew a prepaid resource
POST /api/marketplace-resources/{uuid}/set_end_date_by_staff/ Set end date of the resource by staff
POST /api/marketplace-resources/{uuid}/set_restrict_member_access/ Set restrict member access flag
POST /api/marketplace-resources/{uuid}/set_slug/ Set resource slug
POST /api/marketplace-resources/{uuid}/switch_plan/ Switch resource plan
POST /api/marketplace-resources/{uuid}/update_limits/ Update resource limits
POST /api/marketplace-resources/{uuid}/update_options/ Update resource options
Data & Reporting
GET /api/marketplace-resources/{uuid}/details/ Get resource details
GET /api/marketplace-resources/{uuid}/glauth_users_config/ Get GLauth user configuration for a resource
GET /api/marketplace-resources/{uuid}/offering_for_subresources/ List offerings for sub-resources
GET /api/marketplace-resources/{uuid}/offering/ Get offering details
GET /api/marketplace-resources/{uuid}/plan_periods/ List resource plan periods
GET /api/marketplace-resources/{uuid}/team/ Get resource team
Naming
POST /api/marketplace-resources/suggest_name/ Suggest a resource name
Other Actions
GET /api/marketplace-resources/{uuid}/history/at/ Get object state at a specific timestamp
GET /api/marketplace-resources/{uuid}/history/ Get version history
POST /api/marketplace-resources/{uuid}/estimate_renewal/ Estimate renewal cost breakdown
POST /api/marketplace-resources/{uuid}/reallocate_limits/ Reallocate resource limits
POST /api/marketplace-resources/{uuid}/restore/ Restore

Core CRUD

List consumer resources

Returns a paginated list of resources accessible to the current user as a service consumer.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-resources/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.order_state import OrderState # (1)
from waldur_api_client.models.resource_field_enum import ResourceFieldEnum # (2)
from waldur_api_client.models.resource_o_enum import ResourceOEnum # (3)
from waldur_api_client.models.resource_state import ResourceState # (4)
from waldur_api_client.api.marketplace_resources import marketplace_resources_list # (5)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_resources_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: OrderState
  2. Model Source: ResourceFieldEnum
  3. Model Source: ResourceOEnum
  4. Model Source: ResourceState
  5. API Source: marketplace_resources_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceResourcesList } from 'waldur-js-client';

try {
  const response = await marketplaceResourcesList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
backend_id string Backend ID
category_uuid string (uuid) Category UUID
component_count number Filter by exact number of components
created string (date-time) Created after
customer string (uri) Customer URL
customer_uuid string (uuid) Customer UUID
downscaled boolean Downscaled
field array
has_terminate_date boolean Has termination date
is_attached boolean Filter by attached state
lexis_links_supported boolean LEXIS links supported
limit_based boolean Filter by limit-based offerings
limit_component_count number Filter by exact number of limit-based components
modified string (date-time) Modified after
name string Name
name_exact string Name (exact)
o array Ordering
offering string (uri)
offering_billable boolean Offering billable
offering_shared boolean Offering shared
offering_slug array Multiple values may be separated by commas.
offering_type string Offering type
offering_uuid array Multiple values may be separated by commas.
only_limit_based boolean Filter resources with only limit-based components
only_usage_based boolean Filter resources with only usage-based components
order_state array Order state
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
parent_offering_uuid string (uuid)
paused boolean Paused
plan_uuid string (uuid) Plan UUID
project_name string Project name
project_uuid string (uuid) Project UUID
provider_uuid string (uuid) Provider UUID
query string Search by resource UUID, name, slug, backend ID, effective ID, IPs or hypervisor
restrict_member_access boolean Restrict member access
runtime_state string Runtime state
scope string (uri) Filter by scope URL.
service_manager_uuid string (uuid) Service manager UUID
state array Resource state
usage_based boolean Filter by usage-based offerings
visible_to_providers boolean Include only resources visible to service providers
visible_to_username string Visible to username

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
offering string (uri)
offering_name string
offering_uuid string (uuid)
offering_description string
offering_image string (uri)
offering_thumbnail string (uri)
offering_type string
offering_shared boolean Accessible to all customers.
offering_billable boolean Purchase and usage is invoiced.
offering_plugin_options any Public data used by specific plugin, such as storage mode for OpenStack.
provider_name string
provider_uuid string (uuid)
provider_slug string
category_title string
category_uuid string (uuid)
category_icon string (uri)
plan string (uri)
plan_unit any
plan_name string
plan_uuid string (uuid)
plan_description string
attributes object (free-form)
limits object (free-form)
uuid string (uuid)
created string (date-time)
modified string (date-time)
url string (uri)
scope string
description string
state any
resource_uuid string (uuid)
backend_id string
effective_id string
resource_type string
project string (uri)
project_uuid string (uuid)
project_name string
project_description string
project_end_date string (date) The date is inclusive. Once reached, all project resource will be scheduled for termination.
project_end_date_requested_by string (uri)
customer_uuid string (uuid)
customer_name string
offering_slug string
parent_offering_uuid string (uuid)
parent_offering_name string
parent_offering_slug string
offering_backend_id string
parent_uuid string (uuid)
parent_name string
backend_metadata any
is_usage_based boolean Returns True if the resource has usage-based components that track variable consumption.
is_limit_based boolean Returns True if the resource has limit-based components with user-adjustable quotas.
name string
slug string URL-friendly identifier. Only editable by staff users.
current_usages object (free-form) Dictionary mapping component types to their latest reported usage amounts.
can_terminate boolean
report array of objects
report.header string Section header text
report.body string Section body content
end_date string (date) The date is inclusive. Once reached, a resource will be scheduled for termination.
end_date_requested_by string (uri)
username string
limit_usage object (free-form) Dictionary mapping limit-based component types to their consumed usage. For monthly periods, maps from current_usages; for longer periods, aggregates historical usage.
downscaled boolean
restrict_member_access boolean
paused boolean
endpoints array of objects
endpoints.uuid string (uuid)
endpoints.name string
endpoints.url string URL of the access endpoint
error_message string
error_traceback string
options any
available_actions array of strings
last_sync string (date-time)
order_in_progress any
creation_order any
service_settings_uuid string (uuid)
project_slug string
customer_slug string
user_requires_reconsent boolean Check if the current user needs to re-consent for this resource's offering.
renewal_date object (free-form)
offering_state any
offering_components array of objects
offering_components.uuid string (uuid)
offering_components.billing_type string
Enum: fixed, usage, limit, one, few
offering_components.type string Unique internal name of the measured unit, for example floating_ip.
offering_components.name string Display name for the measured unit, for example, Floating IP.
offering_components.description string
offering_components.measured_unit string Unit of measurement, for example, GB.
offering_components.unit_factor integer The conversion factor from backend units to measured_unit
offering_components.limit_period any
offering_components.limit_amount integer
offering_components.article_code string
offering_components.max_value integer
offering_components.min_value integer
offering_components.max_available_limit integer
offering_components.is_boolean boolean
offering_components.default_limit integer
offering_components.factor integer
offering_components.is_builtin boolean
offering_components.is_prepaid boolean
offering_components.overage_component string (uuid)
offering_components.min_prepaid_duration integer
offering_components.max_prepaid_duration integer

Retrieve a consumer resource

Returns details of a specific resource accessible to the consumer.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.resource_field_enum import ResourceFieldEnum # (1)
from waldur_api_client.api.marketplace_resources import marketplace_resources_retrieve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_resources_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. Model Source: ResourceFieldEnum
  2. API Source: marketplace_resources_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceResourcesRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceResourcesRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type
field array

200 -

Field Type Description
offering string (uri)
offering_name string
offering_uuid string (uuid)
offering_description string
offering_image string (uri)
offering_thumbnail string (uri)
offering_type string
offering_shared boolean Accessible to all customers.
offering_billable boolean Purchase and usage is invoiced.
offering_plugin_options any Public data used by specific plugin, such as storage mode for OpenStack.
provider_name string
provider_uuid string (uuid)
provider_slug string
category_title string
category_uuid string (uuid)
category_icon string (uri)
plan string (uri)
plan_unit any
plan_name string
plan_uuid string (uuid)
plan_description string
attributes object (free-form)
limits object (free-form)
uuid string (uuid)
created string (date-time)
modified string (date-time)
url string (uri)
scope string
description string
state any
resource_uuid string (uuid)
backend_id string
effective_id string
resource_type string
project string (uri)
project_uuid string (uuid)
project_name string
project_description string
project_end_date string (date) The date is inclusive. Once reached, all project resource will be scheduled for termination.
project_end_date_requested_by string (uri)
customer_uuid string (uuid)
customer_name string
offering_slug string
parent_offering_uuid string (uuid)
parent_offering_name string
parent_offering_slug string
offering_backend_id string
parent_uuid string (uuid)
parent_name string
backend_metadata any
is_usage_based boolean Returns True if the resource has usage-based components that track variable consumption.
is_limit_based boolean Returns True if the resource has limit-based components with user-adjustable quotas.
name string
slug string URL-friendly identifier. Only editable by staff users.
current_usages object (free-form) Dictionary mapping component types to their latest reported usage amounts.
can_terminate boolean
report array of objects
report.header string Section header text
report.body string Section body content
end_date string (date) The date is inclusive. Once reached, a resource will be scheduled for termination.
end_date_requested_by string (uri)
username string
limit_usage object (free-form) Dictionary mapping limit-based component types to their consumed usage. For monthly periods, maps from current_usages; for longer periods, aggregates historical usage.
downscaled boolean
restrict_member_access boolean
paused boolean
endpoints array of objects
endpoints.uuid string (uuid)
endpoints.name string
endpoints.url string URL of the access endpoint
error_message string
error_traceback string
options any
available_actions array of strings
last_sync string (date-time)
order_in_progress any
creation_order any
service_settings_uuid string (uuid)
project_slug string
customer_slug string
user_requires_reconsent boolean Check if the current user needs to re-consent for this resource's offering.
renewal_date object (free-form)
offering_state any
offering_components array of objects
offering_components.uuid string (uuid)
offering_components.billing_type string
Enum: fixed, usage, limit, one, few
offering_components.type string Unique internal name of the measured unit, for example floating_ip.
offering_components.name string Display name for the measured unit, for example, Floating IP.
offering_components.description string
offering_components.measured_unit string Unit of measurement, for example, GB.
offering_components.unit_factor integer The conversion factor from backend units to measured_unit
offering_components.limit_period any
offering_components.limit_amount integer
offering_components.article_code string
offering_components.max_value integer
offering_components.min_value integer
offering_components.max_available_limit integer
offering_components.is_boolean boolean
offering_components.default_limit integer
offering_components.factor integer
offering_components.is_builtin boolean
offering_components.is_prepaid boolean
offering_components.overage_component string (uuid)
offering_components.min_prepaid_duration integer
offering_components.max_prepaid_duration integer

Pull resource data

Schedules a task to pull the latest data for the resource from its backend.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/pull/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_resources import marketplace_resources_pull # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_resources_pull.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_resources_pull
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceResourcesPull } from 'waldur-js-client';

try {
  const response = await marketplaceResourcesPull({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

202 -

Field Type
detail string

Forcefully deletes a marketplace resource and its related plugin resource from the database. This action does not schedule operations on the backend and is intended for cleaning up resources stuck in transitioning states. Requires staff permissions.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/unlink/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_resources import marketplace_resources_unlink # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_resources_unlink.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_resources_unlink
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceResourcesUnlink } from 'waldur-js-client';

try {
  const response = await marketplaceResourcesUnlink({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

403 - No response body

Update a consumer resource

Updates the name, description, or end date of a resource.

1
2
3
4
5
http \
  PUT \
  https://api.example.com/api/marketplace-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-marketplace-resource"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.resource_update_request import ResourceUpdateRequest # (1)
from waldur_api_client.api.marketplace_resources import marketplace_resources_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ResourceUpdateRequest(
    name="my-awesome-marketplace-resource"
)
response = marketplace_resources_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ResourceUpdateRequest
  2. API Source: marketplace_resources_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { marketplaceResourcesUpdate } from 'waldur-js-client';

try {
  const response = await marketplaceResourcesUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-marketplace-resource"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
name string ✓
description string
end_date string (date) The date is inclusive. Once reached, a resource will be scheduled for termination.

200 -

Field Type Description
name string
description string
end_date string (date) The date is inclusive. Once reached, a resource will be scheduled for termination.

Partially update a consumer resource

Partially updates the name, description, or end date of a resource.

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/marketplace-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_resource_update_request import PatchedResourceUpdateRequest # (1)
from waldur_api_client.api.marketplace_resources import marketplace_resources_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedResourceUpdateRequest()
response = marketplace_resources_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedResourceUpdateRequest
  2. API Source: marketplace_resources_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceResourcesPartialUpdate } from 'waldur-js-client';

try {
  const response = await marketplaceResourcesPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
name string
description string
end_date string (date) The date is inclusive. Once reached, a resource will be scheduled for termination.

200 -

Field Type Description
name string
description string
end_date string (date) The date is inclusive. Once reached, a resource will be scheduled for termination.

State Management

Set downscaled flag for resource

Sets the 'downscaled' flag for a resource. Requires staff permissions.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_downscaled/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.resource_downscaled_request import ResourceDownscaledRequest # (1)
from waldur_api_client.api.marketplace_resources import marketplace_resources_set_downscaled # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ResourceDownscaledRequest()
response = marketplace_resources_set_downscaled.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ResourceDownscaledRequest
  2. API Source: marketplace_resources_set_downscaled
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceResourcesSetDownscaled } from 'waldur-js-client';

try {
  const response = await marketplaceResourcesSetDownscaled({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
downscaled boolean

200 -

Field Type
status string

Set paused flag for resource

Sets the 'paused' flag for a resource. Requires staff permissions.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_paused/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.resource_paused_request import ResourcePausedRequest # (1)
from waldur_api_client.api.marketplace_resources import marketplace_resources_set_paused # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ResourcePausedRequest()
response = marketplace_resources_set_paused.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ResourcePausedRequest
  2. API Source: marketplace_resources_set_paused
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceResourcesSetPaused } from 'waldur-js-client';

try {
  const response = await marketplaceResourcesSetPaused({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
paused boolean

200 -

Field Type
status string

Terminate a resource

Creates a marketplace order to terminate the resource. This action is asynchronous and may require approval.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/terminate/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.resource_terminate_request import ResourceTerminateRequest # (1)
from waldur_api_client.api.marketplace_resources import marketplace_resources_terminate # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ResourceTerminateRequest()
response = marketplace_resources_terminate.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ResourceTerminateRequest
  2. API Source: marketplace_resources_terminate
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceResourcesTerminate } from 'waldur-js-client';

try {
  const response = await marketplaceResourcesTerminate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
attributes any Optional attributes/parameters to pass to the termination operation

200 -

Field Type Description
order_uuid string (uuid) UUID of the created or updated order

Configuration & Updates

Move a resource to another project

Moves a resource and its associated data to a different project. Requires staff permissions.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/marketplace-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/move_resource/ \
  Authorization:"Token YOUR_API_TOKEN" \
  project=null

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.move_resource_request import MoveResourceRequest # (1)
from waldur_api_client.api.marketplace_resources import marketplace_resources_move_resource # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = MoveResourceRequest(
    project=null
)
response = marketplace_resources_move_resource.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: MoveResourceRequest
  2. API Source: marketplace_resources_move_resource
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { marketplaceResourcesMoveResource } from 'waldur-js-client';

try {
  const response = await marketplaceResourcesMoveResource({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "project": null
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
project any ✓ Target project URL where the resource should be moved
Constraints: write-only

200 -

Field Type Description
offering string (uri)
offering_name string
offering_uuid string (uuid)
offering_description string
offering_image string (uri)
offering_thumbnail string (uri)
offering_type string
offering_shared boolean Accessible to all customers.
offering_billable boolean Purchase and usage is invoiced.
offering_plugin_options any Public data used by specific plugin, such as storage mode for OpenStack.
provider_name string
provider_uuid string (uuid)
provider_slug string
category_title string
category_uuid string (uuid)
category_icon string (uri)
plan string (uri)
plan_unit any
plan_name string
plan_uuid string (uuid)
plan_description string
attributes object (free-form)
limits object (free-form)
uuid string (uuid)
created string (date-time)
modified string (date-time)
url string (uri)
scope string
description string
state any
resource_uuid string (uuid)
backend_id string
effective_id string
resource_type string
project string (uri)
project_uuid string (uuid)
project_name string
project_description string
project_end_date string (date) The date is inclusive. Once reached, all project resource will be scheduled for termination.
project_end_date_requested_by string (uri)
customer_uuid string (uuid)
customer_name string
offering_slug string
parent_offering_uuid string (uuid)
parent_offering_name string
parent_offering_slug string
offering_backend_id string
parent_uuid string (uuid)
parent_name string
backend_metadata any
is_usage_based boolean Returns True if the resource has usage-based components that track variable consumption.
is_limit_based boolean Returns True if the resource has limit-based components with user-adjustable quotas.
name string
slug string URL-friendly identifier. Only editable by staff users.
current_usages object (free-form) Dictionary mapping component types to their latest reported usage amounts.
can_terminate boolean
report array of objects
report.header string Section header text
report.body string Section body content
end_date string (date) The date is inclusive. Once reached, a resource will be scheduled for termination.
end_date_requested_by string (uri)
username string
limit_usage object (free-form) Dictionary mapping limit-based component types to their consumed usage. For monthly periods, maps from current_usages; for longer periods, aggregates historical usage.
downscaled boolean
restrict_member_access boolean
paused boolean
endpoints array of objects
endpoints.uuid string (uuid)
endpoints.name string
endpoints.url string URL of the access endpoint
error_message string
error_traceback string
options any
available_actions array of strings
last_sync string (date-time)
order_in_progress any
creation_order any
service_settings_uuid string (uuid)
project_slug string
customer_slug string
user_requires_reconsent boolean Check if the current user needs to re-consent for this resource's offering.
renewal_date object (free-form)
offering_state any
offering_components array of objects
offering_components.uuid string (uuid)
offering_components.billing_type string
Enum: fixed, usage, limit, one, few
offering_components.type string Unique internal name of the measured unit, for example floating_ip.
offering_components.name string Display name for the measured unit, for example, Floating IP.
offering_components.description string
offering_components.measured_unit string Unit of measurement, for example, GB.
offering_components.unit_factor integer The conversion factor from backend units to measured_unit
offering_components.limit_period any
offering_components.limit_amount integer
offering_components.article_code string
offering_components.max_value integer
offering_components.min_value integer
offering_components.max_available_limit integer
offering_components.is_boolean boolean
offering_components.default_limit integer
offering_components.factor integer
offering_components.is_builtin boolean
offering_components.is_prepaid boolean
offering_components.overage_component string (uuid)
offering_components.min_prepaid_duration integer
offering_components.max_prepaid_duration integer

Renew a prepaid resource

Creates a renewal order to extend the subscription period of a prepaid resource. Optionally, limits can be upgraded at the same time.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/marketplace-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/renew/ \
  Authorization:"Token YOUR_API_TOKEN" \
  extension_months=123

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.resource_renew_request import ResourceRenewRequest # (1)
from waldur_api_client.api.marketplace_resources import marketplace_resources_renew # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ResourceRenewRequest(
    extension_months=123
)
response = marketplace_resources_renew.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ResourceRenewRequest
  2. API Source: marketplace_resources_renew
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { marketplaceResourcesRenew } from 'waldur-js-client';

try {
  const response = await marketplaceResourcesRenew({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "extension_months": 123
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
extension_months integer ✓ Number of months to extend the subscription by.
limits object (free-form) Optional new limits for the resource. Supports upgrades only.
request_comment string Optional comment for the renewal request.
attachment string (binary) Optional PDF attachment for the renewal request.

200 -

Field Type Description
order_uuid string (uuid) UUID of the created or updated order

Set end date of the resource by staff

Allows a staff user to set or update the end date for a resource, which will schedule it for termination.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_end_date_by_staff/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.resource_end_date_by_provider_request import ResourceEndDateByProviderRequest # (1)
from waldur_api_client.api.marketplace_resources import marketplace_resources_set_end_date_by_staff # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ResourceEndDateByProviderRequest()
response = marketplace_resources_set_end_date_by_staff.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ResourceEndDateByProviderRequest
  2. API Source: marketplace_resources_set_end_date_by_staff
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceResourcesSetEndDateByStaff } from 'waldur-js-client';

try {
  const response = await marketplaceResourcesSetEndDateByStaff({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
end_date string (date) The date is inclusive. Once reached, a resource will be scheduled for termination.

200 - No response body

Set restrict member access flag

Sets the 'restrict_member_access' flag for a resource. Requires staff permissions.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_restrict_member_access/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.resource_restrict_member_access_request import ResourceRestrictMemberAccessRequest # (1)
from waldur_api_client.api.marketplace_resources import marketplace_resources_set_restrict_member_access # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ResourceRestrictMemberAccessRequest()
response = marketplace_resources_set_restrict_member_access.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ResourceRestrictMemberAccessRequest
  2. API Source: marketplace_resources_set_restrict_member_access
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceResourcesSetRestrictMemberAccess } from 'waldur-js-client';

try {
  const response = await marketplaceResourcesSetRestrictMemberAccess({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
restrict_member_access boolean

200 -

Field Type
status string

Set resource slug

Updates the slug for a resource. Requires staff permissions.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/marketplace-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_slug/ \
  Authorization:"Token YOUR_API_TOKEN" \
  slug="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.resource_slug_request import ResourceSlugRequest # (1)
from waldur_api_client.api.marketplace_resources import marketplace_resources_set_slug # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ResourceSlugRequest(
    slug="string-value"
)
response = marketplace_resources_set_slug.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ResourceSlugRequest
  2. API Source: marketplace_resources_set_slug
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { marketplaceResourcesSetSlug } from 'waldur-js-client';

try {
  const response = await marketplaceResourcesSetSlug({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "slug": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
slug string ✓

200 -

Field Type
status string

Switch resource plan

Creates a marketplace order to switch the billing plan for a resource. This action is asynchronous and may require approval.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/marketplace-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/switch_plan/ \
  Authorization:"Token YOUR_API_TOKEN" \
  plan="https://api.example.com/api/plan/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.resource_switch_plan_request import ResourceSwitchPlanRequest # (1)
from waldur_api_client.api.marketplace_resources import marketplace_resources_switch_plan # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ResourceSwitchPlanRequest(
    plan="https://api.example.com/api/plan/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = marketplace_resources_switch_plan.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ResourceSwitchPlanRequest
  2. API Source: marketplace_resources_switch_plan
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { marketplaceResourcesSwitchPlan } from 'waldur-js-client';

try {
  const response = await marketplaceResourcesSwitchPlan({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "plan": "https://api.example.com/api/plan/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
plan string (uri) ✓

200 -

Field Type Description
order_uuid string (uuid) UUID of the created or updated order

Update resource limits

Creates a marketplace order to update the limits (e.g., CPU, RAM) for a resource. This action is asynchronous and may require approval.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/marketplace-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/update_limits/ \
  Authorization:"Token YOUR_API_TOKEN" \
  limits:='{}'

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.resource_update_limits_request import ResourceUpdateLimitsRequest # (1)
from waldur_api_client.api.marketplace_resources import marketplace_resources_update_limits # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ResourceUpdateLimitsRequest(
    limits={}
)
response = marketplace_resources_update_limits.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ResourceUpdateLimitsRequest
  2. API Source: marketplace_resources_update_limits
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { marketplaceResourcesUpdateLimits } from 'waldur-js-client';

try {
  const response = await marketplaceResourcesUpdateLimits({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "limits": {}
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
limits object (free-form) ✓
request_comment string

200 -

Field Type Description
order_uuid string (uuid) UUID of the created or updated order

Update resource options

Updates the options of a resource. If the offering is configured to create orders for option changes, a new UPDATE order will be created. Otherwise, the options are updated directly.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/update_options/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.resource_options_request import ResourceOptionsRequest # (1)
from waldur_api_client.api.marketplace_resources import marketplace_resources_update_options # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ResourceOptionsRequest()
response = marketplace_resources_update_options.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ResourceOptionsRequest
  2. API Source: marketplace_resources_update_options
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceResourcesUpdateOptions } from 'waldur-js-client';

try {
  const response = await marketplaceResourcesUpdateOptions({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
options any

200 -

Field Type Description
status string Status of the resource response

201 -

Field Type Description
order_uuid string (uuid) UUID of the created or updated order

409 - No response body

Data & Reporting

Get resource details

Returns the detailed representation of the backend resource associated with the marketplace resource. The format of the response depends on the resource type.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/details/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_resources import marketplace_resources_details_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_resources_details_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_resources_details_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceResourcesDetailsRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceResourcesDetailsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

204 -

404 -

Get GLauth user configuration for a resource

1
2
    This endpoint provides a GLauth configuration file for the users associated with the project of this resource.
    It is intended for use by an external agent to synchronize user data from Waldur to GLauth.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/glauth_users_config/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_resources import marketplace_resources_glauth_users_config_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_resources_glauth_users_config_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_resources_glauth_users_config_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceResourcesGlauthUsersConfigRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceResourcesGlauthUsersConfigRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

List offerings for sub-resources

Returns a list of offerings that can be provisioned as sub-resources of the current resource.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/offering_for_subresources/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_resources import marketplace_resources_offering_for_subresources_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_resources_offering_for_subresources_list.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

for item in response:
    print(item)
  1. API Source: marketplace_resources_offering_for_subresources_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceResourcesOfferingForSubresourcesList } from 'waldur-js-client';

try {
  const response = await marketplaceResourcesOfferingForSubresourcesList({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid) UUID of the offering
type string Type of the offering

Get offering details

Returns details of the offering connected to the requested object.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/offering/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_resources import marketplace_resources_offering_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_resources_offering_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_resources_offering_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceResourcesOfferingRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceResourcesOfferingRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
url string (uri)
uuid string (uuid)
created string (date-time)
name string
slug string URL-friendly identifier. Only editable by staff users.
description string
full_description string
privacy_policy_link string (uri)
access_url string (uri) Publicly accessible offering access URL
endpoints array of objects
endpoints.uuid string (uuid)
endpoints.name string
endpoints.url string URL of the access endpoint
software_catalogs array of objects
software_catalogs.uuid string (uuid)
software_catalogs.catalog any
software_catalogs.enabled_cpu_family any List of enabled CPU families: ['x86_64', 'aarch64']
software_catalogs.enabled_cpu_microarchitectures any List of enabled CPU microarchitectures: ['generic', 'zen3']
software_catalogs.package_count integer
software_catalogs.partition any
partitions array of objects
partitions.uuid string (uuid)
partitions.partition_name string Name of the SLURM partition
partitions.cpu_bind integer Default task binding policy (SLURM cpu_bind)
partitions.def_cpu_per_gpu integer Default CPUs allocated per GPU
partitions.max_cpus_per_node integer Maximum allocated CPUs per node
partitions.max_cpus_per_socket integer Maximum allocated CPUs per socket
partitions.def_mem_per_cpu integer (int64) Default memory per CPU in MB
partitions.def_mem_per_gpu integer (int64) Default memory per GPU in MB
partitions.def_mem_per_node integer (int64) Default memory per node in MB
partitions.max_mem_per_cpu integer (int64) Maximum memory per CPU in MB
partitions.max_mem_per_node integer (int64) Maximum memory per node in MB
partitions.default_time integer Default time limit in minutes
partitions.max_time integer Maximum time limit in minutes
partitions.grace_time integer Preemption grace time in seconds
partitions.max_nodes integer Maximum nodes per job
partitions.min_nodes integer Minimum nodes per job
partitions.exclusive_topo boolean Exclusive topology access required
partitions.exclusive_user boolean Exclusive user access required
partitions.priority_tier integer Priority tier for scheduling and preemption
partitions.qos string Quality of Service (QOS) name
partitions.req_resv boolean Require reservation for job allocation
roles array of objects
roles.uuid string (uuid)
roles.name string
roles.url string (uri)
customer string (uri)
customer_uuid string (uuid)
customer_name string
project string (uri)
project_uuid string (uuid)
project_name string
category string (uri)
category_uuid string (uuid)
category_title string
attributes object (free-form)
options any
resource_options any
components array of objects
components.uuid string (uuid)
components.billing_type string
Enum: fixed, usage, limit, one, few
components.type string Unique internal name of the measured unit, for example floating_ip.
components.name string Display name for the measured unit, for example, Floating IP.
components.description string
components.measured_unit string Unit of measurement, for example, GB.
components.unit_factor integer The conversion factor from backend units to measured_unit
components.limit_period any
components.limit_amount integer
components.article_code string
components.max_value integer
components.min_value integer
components.max_available_limit integer
components.is_boolean boolean
components.default_limit integer
components.factor integer
components.is_builtin boolean
components.is_prepaid boolean
components.overage_component string (uuid)
components.min_prepaid_duration integer
components.max_prepaid_duration integer
plugin_options any
state any
vendor_details string
getting_started string
integration_guide string
thumbnail string (uri)
order_count integer
plans array of objects
plans.url string (uri)
plans.uuid string (uuid)
plans.name string
plans.description string
plans.article_code string
plans.max_amount integer Maximum number of plans that could be active. Plan is disabled when maximum amount is reached.
plans.archived boolean Forbids creation of new resources.
plans.is_active boolean
plans.unit_price string (decimal)
plans.unit string
Enum: month, quarter, half_month, day, hour, quantity
plans.init_price number (double)
plans.switch_price number (double)
plans.backend_id string
plans.organization_groups array of objects
plans.organization_groups.uuid string (uuid)
plans.organization_groups.url string (uri)
plans.organization_groups.name string
plans.organization_groups.parent_uuid string (uuid) UUID of the parent organization group
plans.organization_groups.parent_name string Name of the parent organization group
plans.organization_groups.parent string (uri)
plans.organization_groups.customers_count integer Number of customers in this organization group
plans.components array of objects
plans.components.type string Unique internal name of the measured unit, for example floating_ip.
plans.components.name string Display name for the measured unit, for example, Floating IP.
plans.components.measured_unit string Unit of measurement, for example, GB.
plans.components.amount integer
plans.components.price string (decimal)
plans.components.future_price string (decimal)
plans.components.discount_threshold integer Minimum amount to be eligible for discount.
plans.components.discount_rate integer Discount rate in percentage.
plans.prices object (free-form)
plans.future_prices object (free-form)
plans.quotas object (free-form)
plans.resources_count integer
plans.plan_type string
plans.minimal_price number (double)
screenshots array of objects
screenshots.name string
screenshots.uuid string (uuid)
screenshots.description string
screenshots.image string (uri)
screenshots.thumbnail string (uri)
screenshots.created string (date-time)
type string
shared boolean Accessible to all customers.
billable boolean Purchase and usage is invoiced.
scope string
scope_uuid string (uuid)
scope_name string (uuid)
scope_state any
scope_error_message string
files array of objects
files.name string
files.created string (date-time)
files.file string (uri)
quotas array of objects
quotas.name string
quotas.usage integer
quotas.limit integer
paused_reason string
datacite_doi string
citation_count integer Number of citations of a DOI
latitude number (double)
longitude number (double)
country any Country code (ISO 3166-1 alpha-2)
backend_id string
organization_groups array of objects
organization_groups.uuid string (uuid)
organization_groups.url string (uri)
organization_groups.name string
organization_groups.parent_uuid string (uuid) UUID of the parent organization group
organization_groups.parent_name string Name of the parent organization group
organization_groups.parent string (uri)
organization_groups.customers_count integer Number of customers in this organization group
tags array of objects
tags.uuid string (uuid)
tags.name string
image string (uri)
total_customers integer
total_cost integer
total_cost_estimated integer
parent_description string
parent_uuid string (uuid)
parent_name string
backend_metadata any
has_compliance_requirements boolean
billing_type_classification string Classify offering components by billing type. Returns 'limit_only', 'usage_only', or 'mixed'.
compliance_checklist string (uri)
user_has_consent boolean
is_accessible boolean
google_calendar_is_public boolean
google_calendar_link string Get the Google Calendar link for an offering.
promotion_campaigns array of objects
promotion_campaigns.uuid string (uuid)
promotion_campaigns.name string
promotion_campaigns.start_date string (date) Starting from this date, the campaign is active.
promotion_campaigns.end_date string (date) The last day the campaign is active.
promotion_campaigns.discount_type string
Enum: discount, special_price
promotion_campaigns.discount integer
promotion_campaigns.stock integer
promotion_campaigns.description string
promotion_campaigns.months integer How many months in a row should the related service (when activated) get special deal (0 for indefinitely until active)
promotion_campaigns.service_provider string (uri)

List resource plan periods

Returns a list of active and future plan periods for the resource. Each period includes the plan details and current component usage.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/plan_periods/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_resources import marketplace_resources_plan_periods_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_resources_plan_periods_list.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

for item in response:
    print(item)
  1. API Source: marketplace_resources_plan_periods_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceResourcesPlanPeriodsList } from 'waldur-js-client';

try {
  const response = await marketplaceResourcesPlanPeriodsList({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid)
plan_name string
plan_uuid string (uuid)
start string (date-time)
end string (date-time)
components array of objects
components.uuid string (uuid)
components.created string (date-time)
components.description string
components.type string Unique internal name of the measured unit, for example floating_ip.
components.name string Display name for the measured unit, for example, Floating IP.
components.measured_unit string Unit of measurement, for example, GB.
components.usage string (decimal)
components.date string (date-time)
components.recurring boolean Reported value is reused every month until changed.

Get resource team

Returns a list of users connected to the project of this resource, including their project roles and offering-specific usernames.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/team/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_resources import marketplace_resources_team_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_resources_team_list.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

for item in response:
    print(item)
  1. API Source: marketplace_resources_team_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceResourcesTeamList } from 'waldur-js-client';

try {
  const response = await marketplaceResourcesTeamList({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
full_name string
email string (email)
role string
expiration_time string (date-time)
offering_user_username string
offering_user_state any

Naming

Suggest a resource name

Generates a suggested name for a new resource based on the project and offering. If the offering has a resource_name_pattern in plugin_options, it is used as a Python format string with variables: {customer_name}, {customer_slug}, {project_name}, {project_slug}, {offering_name}, {offering_slug}, {plan_name}, {counter}, and {attributes[KEY]} for any order form value.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/marketplace-resources/suggest_name/ \
  Authorization:"Token YOUR_API_TOKEN" \
  project="a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  offering="a1b2c3d4-e5f6-7890-abcd-ef1234567890"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.resource_suggest_name_request import ResourceSuggestNameRequest # (1)
from waldur_api_client.api.marketplace_resources import marketplace_resources_suggest_name # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ResourceSuggestNameRequest(
    project="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    offering="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
)
response = marketplace_resources_suggest_name.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ResourceSuggestNameRequest
  2. API Source: marketplace_resources_suggest_name
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { marketplaceResourcesSuggestName } from 'waldur-js-client';

try {
  const response = await marketplaceResourcesSuggestName({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "project": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "offering": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required
project string (uuid) ✓
offering string (uuid) ✓
plan string (uuid)
attributes any

200 -

Field Type
name string

Other Actions

Get object state at a specific timestamp

Returns the state of the object as it was at the specified timestamp. Only accessible by staff and support users.

1
2
3
4
5
http \
  GET \
  https://api.example.com/api/marketplace-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/history/at/ \
  Authorization:"Token YOUR_API_TOKEN" \
  timestamp=="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_resources import marketplace_resources_history_at_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_resources_history_at_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    timestamp="string-value"
)

print(response)
  1. API Source: marketplace_resources_history_at_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { marketplaceResourcesHistoryAtRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceResourcesHistoryAtRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  query: {
    "timestamp": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type Required Description
timestamp string ✓ ISO 8601 timestamp to query the object state at

200 -

Field Type Description
id integer Version ID
revision_date string (date-time) When this revision was created
revision_user object (free-form) User who created this revision
revision_comment string Comment describing the revision
serialized_data object (free-form) Serialized model fields at this revision

400 -

404 -

Get version history

Returns the version history for this object. Only accessible by staff and support users.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/history/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.order_state import OrderState # (1)
from waldur_api_client.models.resource_o_enum import ResourceOEnum # (2)
from waldur_api_client.models.resource_state import ResourceState # (3)
from waldur_api_client.api.marketplace_resources import marketplace_resources_history_list # (4)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_resources_history_list.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

for item in response:
    print(item)
  1. Model Source: OrderState
  2. Model Source: ResourceOEnum
  3. Model Source: ResourceState
  4. API Source: marketplace_resources_history_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceResourcesHistoryList } from 'waldur-js-client';

try {
  const response = await marketplaceResourcesHistoryList({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type Description
backend_id string Backend ID
category_uuid string (uuid) Category UUID
component_count number Filter by exact number of components
created string (date-time) Created after
created_after string Filter versions created after this timestamp (ISO 8601)
created_before string Filter versions created before this timestamp (ISO 8601)
customer string (uri) Customer URL
customer_uuid string (uuid) Customer UUID
downscaled boolean Downscaled
has_terminate_date boolean Has termination date
is_attached boolean Filter by attached state
lexis_links_supported boolean LEXIS links supported
limit_based boolean Filter by limit-based offerings
limit_component_count number Filter by exact number of limit-based components
modified string (date-time) Modified after
name string Name
name_exact string Name (exact)
o array Ordering
offering string (uri)
offering_billable boolean Offering billable
offering_shared boolean Offering shared
offering_slug array Multiple values may be separated by commas.
offering_type string Offering type
offering_uuid array Multiple values may be separated by commas.
only_limit_based boolean Filter resources with only limit-based components
only_usage_based boolean Filter resources with only usage-based components
order_state array Order state
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
parent_offering_uuid string (uuid)
paused boolean Paused
plan_uuid string (uuid) Plan UUID
project_name string Project name
project_uuid string (uuid) Project UUID
provider_uuid string (uuid) Provider UUID
query string Search by resource UUID, name, slug, backend ID, effective ID, IPs or hypervisor
restrict_member_access boolean Restrict member access
runtime_state string Runtime state
scope string (uri) Filter by scope URL.
service_manager_uuid string (uuid) Service manager UUID
state array Resource state
usage_based boolean Filter by usage-based offerings
visible_to_providers boolean Include only resources visible to service providers
visible_to_username string Visible to username

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
id integer Version ID
revision_date string (date-time) When this revision was created
revision_user object (free-form) User who created this revision
revision_comment string Comment describing the revision
serialized_data object (free-form) Serialized model fields at this revision

Estimate renewal cost breakdown

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/marketplace-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/estimate_renewal/ \
  Authorization:"Token YOUR_API_TOKEN" \
  extension_months=123

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.renewal_estimate_request_request import RenewalEstimateRequestRequest # (1)
from waldur_api_client.api.marketplace_resources import marketplace_resources_estimate_renewal # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = RenewalEstimateRequestRequest(
    extension_months=123
)
response = marketplace_resources_estimate_renewal.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: RenewalEstimateRequestRequest
  2. API Source: marketplace_resources_estimate_renewal
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { marketplaceResourcesEstimateRenewal } from 'waldur-js-client';

try {
  const response = await marketplaceResourcesEstimateRenewal({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "extension_months": 123
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
extension_months integer ✓
limits object (free-form)

200 -

Field Type
components array of objects
components.component_type string
components.component_name string
components.billing_type string
components.billing_period string
components.current_limit integer
components.new_limit integer
components.unit_price string (decimal)
components.measured_unit string
components.period_description string
components.total string (decimal)
subscription_total string (decimal)
limit_change_total string (decimal)
total string (decimal)
remaining_days integer
new_end_date string (date)

Reallocate resource limits

Creates marketplace orders to reallocate limits from source resource to target resources.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/marketplace-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/reallocate_limits/ \
  Authorization:"Token YOUR_API_TOKEN" \
  limits:='{}' \
  targets:='[]'

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.resource_reallocate_limits_request import ResourceReallocateLimitsRequest # (1)
from waldur_api_client.api.marketplace_resources import marketplace_resources_reallocate_limits # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ResourceReallocateLimitsRequest(
    limits={},
    targets=[]
)
response = marketplace_resources_reallocate_limits.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ResourceReallocateLimitsRequest
  2. API Source: marketplace_resources_reallocate_limits
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { marketplaceResourcesReallocateLimits } from 'waldur-js-client';

try {
  const response = await marketplaceResourcesReallocateLimits({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "limits": {},
    "targets": []
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
limits object (free-form) ✓
targets array of objects ✓
targets.resource_uuid string (uuid) ✓
targets.allocated_limits object (free-form) ✓

200 -

Field Type Description
source_order_uuid string (uuid) UUID of the source order for limit reallocation
target_order_uuids array of string (uuid)s List of UUIDs for target orders receiving the reallocated limits

Restore

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/marketplace-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/restore/ \
  Authorization:"Token YOUR_API_TOKEN" \
  offering="https://api.example.com/api/offering/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  name="my-awesome-marketplace-resource"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.resource_request import ResourceRequest # (1)
from waldur_api_client.api.marketplace_resources import marketplace_resources_restore # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ResourceRequest(
    offering="https://api.example.com/api/offering/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    name="my-awesome-marketplace-resource"
)
response = marketplace_resources_restore.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ResourceRequest
  2. API Source: marketplace_resources_restore
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { marketplaceResourcesRestore } from 'waldur-js-client';

try {
  const response = await marketplaceResourcesRestore({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "offering": "https://api.example.com/api/offering/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "name": "my-awesome-marketplace-resource"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
offering string (uri) ✓
plan string (uri)
name string ✓
slug string URL-friendly identifier. Only editable by staff users.
end_date string (date) The date is inclusive. Once reached, a resource will be scheduled for termination.
downscaled boolean
paused boolean

200 -

Field Type Description
offering string (uri)
offering_name string
offering_uuid string (uuid)
offering_description string
offering_image string (uri)
offering_thumbnail string (uri)
offering_type string
offering_shared boolean Accessible to all customers.
offering_billable boolean Purchase and usage is invoiced.
offering_plugin_options any Public data used by specific plugin, such as storage mode for OpenStack.
provider_name string
provider_uuid string (uuid)
provider_slug string
category_title string
category_uuid string (uuid)
category_icon string (uri)
plan string (uri)
plan_unit any
plan_name string
plan_uuid string (uuid)
plan_description string
attributes object (free-form)
limits object (free-form)
uuid string (uuid)
created string (date-time)
modified string (date-time)
url string (uri)
scope string
description string
state any
resource_uuid string (uuid)
backend_id string
effective_id string
resource_type string
project string (uri)
project_uuid string (uuid)
project_name string
project_description string
project_end_date string (date) The date is inclusive. Once reached, all project resource will be scheduled for termination.
project_end_date_requested_by string (uri)
customer_uuid string (uuid)
customer_name string
offering_slug string
parent_offering_uuid string (uuid)
parent_offering_name string
parent_offering_slug string
offering_backend_id string
parent_uuid string (uuid)
parent_name string
backend_metadata any
is_usage_based boolean Returns True if the resource has usage-based components that track variable consumption.
is_limit_based boolean Returns True if the resource has limit-based components with user-adjustable quotas.
name string
slug string URL-friendly identifier. Only editable by staff users.
current_usages object (free-form) Dictionary mapping component types to their latest reported usage amounts.
can_terminate boolean
report array of objects
report.header string Section header text
report.body string Section body content
end_date string (date) The date is inclusive. Once reached, a resource will be scheduled for termination.
end_date_requested_by string (uri)
username string
limit_usage object (free-form) Dictionary mapping limit-based component types to their consumed usage. For monthly periods, maps from current_usages; for longer periods, aggregates historical usage.
downscaled boolean
restrict_member_access boolean
paused boolean
endpoints array of objects
endpoints.uuid string (uuid)
endpoints.name string
endpoints.url string URL of the access endpoint
error_message string
error_traceback string
options any
available_actions array of strings
last_sync string (date-time)
order_in_progress any
creation_order any
service_settings_uuid string (uuid)
project_slug string
customer_slug string
user_requires_reconsent boolean Check if the current user needs to re-consent for this resource's offering.
renewal_date object (free-form)
offering_state any
offering_components array of objects
offering_components.uuid string (uuid)
offering_components.billing_type string
Enum: fixed, usage, limit, one, few
offering_components.type string Unique internal name of the measured unit, for example floating_ip.
offering_components.name string Display name for the measured unit, for example, Floating IP.
offering_components.description string
offering_components.measured_unit string Unit of measurement, for example, GB.
offering_components.unit_factor integer The conversion factor from backend units to measured_unit
offering_components.limit_period any
offering_components.limit_amount integer
offering_components.article_code string
offering_components.max_value integer
offering_components.min_value integer
offering_components.max_available_limit integer
offering_components.is_boolean boolean
offering_components.default_limit integer
offering_components.factor integer
offering_components.is_builtin boolean
offering_components.is_prepaid boolean
offering_components.overage_component string (uuid)
offering_components.min_prepaid_duration integer
offering_components.max_prepaid_duration integer

Marketplace Runtime States

Operations Summary

Method Endpoint Description
GET /api/marketplace-runtime-states/ List available runtime states for resources

List available runtime states for resources

1
2
3
4
    Returns a unique, sorted list of runtime states for all resources accessible to the current user.
    The runtime state is a backend-specific state of a resource (e.g., 'ACTIVE', 'SHUTOFF' for a VM).
    This endpoint is useful for building dynamic filters in a user interface.
    The list can be optionally filtered by project or category.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-runtime-states/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_runtime_states import marketplace_runtime_states_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_runtime_states_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: marketplace_runtime_states_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceRuntimeStatesList } from 'waldur-js-client';

try {
  const response = await marketplaceRuntimeStatesList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
category_uuid string (uuid) Filter runtime states by resources belonging to a specific category.
project_uuid string (uuid) Filter runtime states by resources within a specific project.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
value string Value of the runtime state
label string Human-readable label for the runtime state

Site agent

Backend Resource Requests

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/backend-resource-requests/ List backend resource requests
GET /api/backend-resource-requests/{uuid}/ Retrieve a backend resource request
POST /api/backend-resource-requests/ Create a backend resource request
Other Actions
POST /api/backend-resource-requests/{uuid}/set_done/ Mark a request as done
POST /api/backend-resource-requests/{uuid}/set_erred/ Mark a request as erred
POST /api/backend-resource-requests/{uuid}/start_processing/ Start processing a request

Core CRUD

List backend resource requests

Returns a paginated list of requests for backend resources.

1
2
3
4
http \
  GET \
  https://api.example.com/api/backend-resource-requests/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.backend_resource_req_o_enum import BackendResourceReqOEnum # (1)
from waldur_api_client.models.backend_resource_req_state_enum import BackendResourceReqStateEnum # (2)
from waldur_api_client.api.backend_resource_requests import backend_resource_requests_list # (3)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = backend_resource_requests_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: BackendResourceReqOEnum
  2. Model Source: BackendResourceReqStateEnum
  3. API Source: backend_resource_requests_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { backendResourceRequestsList } from 'waldur-js-client';

try {
  const response = await backendResourceRequestsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
created string (date-time) Created after
finished string (date-time) Modified after
modified string (date-time) Modified after
o array Ordering
offering_uuid string (uuid) Offering UUID
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
started string (date-time) Created after
state array Backend resource request state

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
created string (date-time)
modified string (date-time)
started string (date-time) Time when request processing started
finished string (date-time) Time when request processing finished
state any
offering string (uuid)
offering_name string
offering_url string (uri)
error_message string
error_traceback string

Retrieve a backend resource request

Returns the details of a specific backend resource request.

1
2
3
4
http \
  GET \
  https://api.example.com/api/backend-resource-requests/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.backend_resource_requests import backend_resource_requests_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = backend_resource_requests_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: backend_resource_requests_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { backendResourceRequestsRetrieve } from 'waldur-js-client';

try {
  const response = await backendResourceRequestsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
url string (uri)
uuid string (uuid)
created string (date-time)
modified string (date-time)
started string (date-time) Time when request processing started
finished string (date-time) Time when request processing finished
state any
offering string (uuid)
offering_name string
offering_url string (uri)
error_message string
error_traceback string

Create a backend resource request

Creates a new request to fetch a list of importable resources from a backend. This is typically used by staff to trigger a site agent to report available resources.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/backend-resource-requests/ \
  Authorization:"Token YOUR_API_TOKEN" \
  offering="a1b2c3d4-e5f6-7890-abcd-ef1234567890"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.backend_resource_req_request import BackendResourceReqRequest # (1)
from waldur_api_client.api.backend_resource_requests import backend_resource_requests_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = BackendResourceReqRequest(
    offering="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
)
response = backend_resource_requests_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: BackendResourceReqRequest
  2. API Source: backend_resource_requests_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { backendResourceRequestsCreate } from 'waldur-js-client';

try {
  const response = await backendResourceRequestsCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "offering": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required
offering string (uuid) ✓

201 -

Field Type Description
url string (uri)
uuid string (uuid)
created string (date-time)
modified string (date-time)
started string (date-time) Time when request processing started
finished string (date-time) Time when request processing finished
state any
offering string (uuid)
offering_name string
offering_url string (uri)
error_message string
error_traceback string

Other Actions

Mark a request as done

Transitions the request state from 'Processing' to 'Done'. This is used by a site agent to signal that it has successfully reported all available resources.

1
2
3
4
http \
  POST \
  https://api.example.com/api/backend-resource-requests/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_done/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.backend_resource_requests import backend_resource_requests_set_done # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = backend_resource_requests_set_done.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: backend_resource_requests_set_done
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { backendResourceRequestsSetDone } from 'waldur-js-client';

try {
  const response = await backendResourceRequestsSetDone({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
status string

Mark a request as erred

Transitions the request state to 'Erred'. This is used by a site agent to report a failure during the resource fetching process. An error message and traceback should be provided.

1
2
3
4
http \
  POST \
  https://api.example.com/api/backend-resource-requests/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_erred/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.backend_resource_request_set_erred_request import BackendResourceRequestSetErredRequest # (1)
from waldur_api_client.api.backend_resource_requests import backend_resource_requests_set_erred # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = BackendResourceRequestSetErredRequest()
response = backend_resource_requests_set_erred.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: BackendResourceRequestSetErredRequest
  2. API Source: backend_resource_requests_set_erred
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { backendResourceRequestsSetErred } from 'waldur-js-client';

try {
  const response = await backendResourceRequestsSetErred({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
error_message string
error_traceback string

200 -

Field Type
status string

Start processing a request

Transitions the request state from 'Sent' to 'Processing'. This is used by a site agent to acknowledge that it has started fetching the resource list.

1
2
3
4
http \
  POST \
  https://api.example.com/api/backend-resource-requests/a1b2c3d4-e5f6-7890-abcd-ef1234567890/start_processing/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.backend_resource_requests import backend_resource_requests_start_processing # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = backend_resource_requests_start_processing.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: backend_resource_requests_start_processing
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { backendResourceRequestsStartProcessing } from 'waldur-js-client';

try {
  const response = await backendResourceRequestsStartProcessing({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
status string

Backend Resources

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/backend-resources/ List backend resources
GET /api/backend-resources/{uuid}/ Retrieve a backend resource
POST /api/backend-resources/ Create a backend resource
DELETE /api/backend-resources/{uuid}/ Delete a backend resource
Other Actions
POST /api/backend-resources/{uuid}/import_resource/ Import a backend resource (staff only)

Core CRUD

List backend resources

Returns a paginated list of backend resources that are available for import. This endpoint is typically used by site agents to see which resources they have reported.

1
2
3
4
http \
  GET \
  https://api.example.com/api/backend-resources/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.backend_resource_req_o_enum import BackendResourceReqOEnum # (1)
from waldur_api_client.api.backend_resources import backend_resources_list # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = backend_resources_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: BackendResourceReqOEnum
  2. API Source: backend_resources_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { backendResourcesList } from 'waldur-js-client';

try {
  const response = await backendResourcesList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
backend_id string Backend ID
created string (date-time) Created after
modified string (date-time) Modified after
name string Name
name_exact string Name (exact)
o array Ordering
offering_uuid string (uuid) Offering UUID
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
project_uuid string (uuid) Project UUID

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
url string (uri)
uuid string (uuid)
name string
created string (date-time)
modified string (date-time)
project string (uuid)
project_name string
project_url string (uri)
offering string (uuid)
offering_name string
offering_url string (uri)
backend_id string
backend_metadata any

Retrieve a backend resource

Returns the details of a specific backend resource.

1
2
3
4
http \
  GET \
  https://api.example.com/api/backend-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.backend_resources import backend_resources_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = backend_resources_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: backend_resources_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { backendResourcesRetrieve } from 'waldur-js-client';

try {
  const response = await backendResourcesRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
url string (uri)
uuid string (uuid)
name string
created string (date-time)
modified string (date-time)
project string (uuid)
project_name string
project_url string (uri)
offering string (uuid)
offering_name string
offering_url string (uri)
backend_id string
backend_metadata any

Create a backend resource

Creates a new backend resource record. This is typically done by a site agent to report a resource that is available for import into the marketplace.

1
2
3
4
5
6
7
http \
  POST \
  https://api.example.com/api/backend-resources/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-backend-resource" \
  project="a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  offering="a1b2c3d4-e5f6-7890-abcd-ef1234567890"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.backend_resource_request import BackendResourceRequest # (1)
from waldur_api_client.api.backend_resources import backend_resources_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = BackendResourceRequest(
    name="my-awesome-backend-resource",
    project="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    offering="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
)
response = backend_resources_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: BackendResourceRequest
  2. API Source: backend_resources_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
import { backendResourcesCreate } from 'waldur-js-client';

try {
  const response = await backendResourcesCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "name": "my-awesome-backend-resource",
    "project": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "offering": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required
name string ✓
project string (uuid) ✓
offering string (uuid) ✓
backend_id string
backend_metadata any

201 -

Field Type
url string (uri)
uuid string (uuid)
name string
created string (date-time)
modified string (date-time)
project string (uuid)
project_name string
project_url string (uri)
offering string (uuid)
offering_name string
offering_url string (uri)
backend_id string
backend_metadata any

Delete a backend resource

Deletes a backend resource record. This is typically done when the resource is no longer available for import.

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/backend-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.backend_resources import backend_resources_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = backend_resources_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: backend_resources_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { backendResourcesDestroy } from 'waldur-js-client';

try {
  const response = await backendResourcesDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Other Actions

Import a backend resource (staff only)

1
2
3
    Converts a backend resource into a full marketplace resource. This action is restricted to staff users.
    Upon successful import, the original backend resource record is deleted. A fake order in the 'done'
    state is created to represent the import event.

1
2
3
4
http \
  POST \
  https://api.example.com/api/backend-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/import_resource/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.backend_resource_import_request import BackendResourceImportRequest # (1)
from waldur_api_client.api.backend_resources import backend_resources_import_resource # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = BackendResourceImportRequest()
response = backend_resources_import_resource.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: BackendResourceImportRequest
  2. API Source: backend_resources_import_resource
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { backendResourcesImportResource } from 'waldur-js-client';

try {
  const response = await backendResourcesImportResource({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
plan string (uuid)

201 -

Field Type Description
offering string (uri)
offering_name string
offering_uuid string (uuid)
offering_description string
offering_image string (uri)
offering_thumbnail string (uri)
offering_type string
offering_shared boolean Accessible to all customers.
offering_billable boolean Purchase and usage is invoiced.
offering_plugin_options any Public data used by specific plugin, such as storage mode for OpenStack.
provider_name string
provider_uuid string (uuid)
provider_slug string
category_title string
category_uuid string (uuid)
category_icon string (uri)
plan string (uri)
plan_unit any
plan_name string
plan_uuid string (uuid)
plan_description string
attributes object (free-form)
limits object (free-form)
uuid string (uuid)
created string (date-time)
modified string (date-time)
url string (uri)
scope string
description string
state any
resource_uuid string (uuid)
backend_id string
effective_id string
resource_type string
project string (uri)
project_uuid string (uuid)
project_name string
project_description string
project_end_date string (date) The date is inclusive. Once reached, all project resource will be scheduled for termination.
project_end_date_requested_by string (uri)
customer_uuid string (uuid)
customer_name string
offering_slug string
parent_offering_uuid string (uuid)
parent_offering_name string
parent_offering_slug string
offering_backend_id string
parent_uuid string (uuid)
parent_name string
backend_metadata any
is_usage_based boolean Returns True if the resource has usage-based components that track variable consumption.
is_limit_based boolean Returns True if the resource has limit-based components with user-adjustable quotas.
name string
slug string URL-friendly identifier. Only editable by staff users.
current_usages object (free-form) Dictionary mapping component types to their latest reported usage amounts.
can_terminate boolean
report array of objects
report.header string Section header text
report.body string Section body content
end_date string (date) The date is inclusive. Once reached, a resource will be scheduled for termination.
end_date_requested_by string (uri)
username string
limit_usage object (free-form) Dictionary mapping limit-based component types to their consumed usage. For monthly periods, maps from current_usages; for longer periods, aggregates historical usage.
downscaled boolean
restrict_member_access boolean
paused boolean
endpoints array of objects
endpoints.uuid string (uuid)
endpoints.name string
endpoints.url string URL of the access endpoint
error_message string
error_traceback string
options any
available_actions array of strings
last_sync string (date-time)
order_in_progress any
creation_order any
service_settings_uuid string (uuid)
project_slug string
customer_slug string
user_requires_reconsent boolean Check if the current user needs to re-consent for this resource's offering.
renewal_date object (free-form)
offering_state any
offering_components array of objects
offering_components.uuid string (uuid)
offering_components.billing_type string
Enum: fixed, usage, limit, one, few
offering_components.type string Unique internal name of the measured unit, for example floating_ip.
offering_components.name string Display name for the measured unit, for example, Floating IP.
offering_components.description string
offering_components.measured_unit string Unit of measurement, for example, GB.
offering_components.unit_factor integer The conversion factor from backend units to measured_unit
offering_components.limit_period any
offering_components.limit_amount integer
offering_components.article_code string
offering_components.max_value integer
offering_components.min_value integer
offering_components.max_available_limit integer
offering_components.is_boolean boolean
offering_components.default_limit integer
offering_components.factor integer
offering_components.is_builtin boolean
offering_components.is_prepaid boolean
offering_components.overage_component string (uuid)
offering_components.min_prepaid_duration integer
offering_components.max_prepaid_duration integer

Marketplace Site Agent Connection Stats

Operations Summary

Method Endpoint Description
GET /api/marketplace-site-agent-connection-stats/ Get agent connection statistics

Get agent connection statistics

Returns connection status for all registered agents.

For each agent identity, provides: - Agent metadata (name, version, offering) - Services and their states - Event subscriptions with RabbitMQ connection status - RabbitMQ queues associated with the agent's offering

The RMQ connection data includes: - Whether the agent is currently connected - Connection source IP, timestamp, and state - Traffic statistics (bytes sent/received)

Requires support user permissions.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-site-agent-connection-stats/ \
  Authorization:"Token YOUR_API_TOKEN"

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_site_agent_connection_stats import marketplace_site_agent_connection_stats_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_site_agent_connection_stats_retrieve.sync(client=client)

print(response)
  1. API Source: marketplace_site_agent_connection_stats_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceSiteAgentConnectionStatsRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceSiteAgentConnectionStatsRetrieve({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

200 -

Field Type Description
agents array of objects List of agents with connection status
agents.uuid string (uuid) Agent identity UUID
agents.name string Agent name
agents.offering_uuid string (uuid) Associated offering UUID
agents.offering_name string Associated offering name
agents.version string Agent version
agents.last_restarted string (date-time) When the agent was last restarted
agents.services array of objects Services running within this agent
agents.services.uuid string (uuid) Service UUID
agents.services.name string Service name
agents.services.state string Service state: ACTIVE, IDLE, or ERROR
agents.services.modified string (date-time) Last modification timestamp
agents.event_subscriptions array of objects Event subscriptions with connection status
agents.event_subscriptions.uuid string (uuid) Event subscription UUID
agents.event_subscriptions.created string (date-time) When the subscription was created
agents.event_subscriptions.observable_objects any List of observable object configurations
agents.event_subscriptions.rmq_connection any RabbitMQ connection status for this subscription
agents.queues array of objects RabbitMQ queues for this agent's offering
agents.queues.name string Queue name
agents.queues.messages integer Number of messages in queue
agents.queues.consumers integer Number of active consumers
agents.queues.object_type string Parsed object type from queue name
summary any Summary statistics

503 -

Marketplace Site Agent Identities

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/marketplace-site-agent-identities/ List Marketplace Site Agent Identities
GET /api/marketplace-site-agent-identities/{uuid}/ Retrieve
POST /api/marketplace-site-agent-identities/ Create
PUT /api/marketplace-site-agent-identities/{uuid}/ Update
DELETE /api/marketplace-site-agent-identities/{uuid}/ Delete
Other Actions
POST /api/marketplace-site-agent-identities/cleanup_orphaned/ Remove agent identities that have no active services. Staff only
POST /api/marketplace-site-agent-identities/{uuid}/register_event_subscription/ Register event subscription
POST /api/marketplace-site-agent-identities/{uuid}/register_service/ Register a new processor or get the existing one for the agent service

Core CRUD

List Marketplace Site Agent Identities

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-site-agent-identities/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_site_agent_identities import marketplace_site_agent_identities_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_site_agent_identities_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: marketplace_site_agent_identities_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceSiteAgentIdentitiesList } from 'waldur-js-client';

try {
  const response = await marketplaceSiteAgentIdentitiesList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
last_restarted string (date-time) Last restarted after
name string
offering_uuid string (uuid)
orphaned boolean Has no services
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
version string

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid)
url string (uri)
offering string (uuid) UUID of an offering with a site-agent compatible type.
name string
version string
dependencies any
config_file_path string Example: '/etc/waldur/agent.yaml'
config_file_content string
last_restarted string (date-time)
created string (date-time)
modified string (date-time)
services array of objects
services.uuid string (uuid)
services.url string (uri)
services.name string
services.mode string
services.state any
services.statistics any
services.created string (date-time)
services.modified string (date-time)

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-site-agent-identities/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_site_agent_identities import marketplace_site_agent_identities_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_site_agent_identities_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_site_agent_identities_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceSiteAgentIdentitiesRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceSiteAgentIdentitiesRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
uuid string (uuid)
url string (uri)
offering string (uuid) UUID of an offering with a site-agent compatible type.
name string
version string
dependencies any
config_file_path string Example: '/etc/waldur/agent.yaml'
config_file_content string
last_restarted string (date-time)
created string (date-time)
modified string (date-time)
services array of objects
services.uuid string (uuid)
services.url string (uri)
services.name string
services.mode string
services.state any
services.statistics any
services.created string (date-time)
services.modified string (date-time)

Create

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/marketplace-site-agent-identities/ \
  Authorization:"Token YOUR_API_TOKEN" \
  offering="a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  name="my-awesome-marketplace-site-agent-identity"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.agent_identity_request import AgentIdentityRequest # (1)
from waldur_api_client.api.marketplace_site_agent_identities import marketplace_site_agent_identities_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = AgentIdentityRequest(
    offering="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    name="my-awesome-marketplace-site-agent-identity"
)
response = marketplace_site_agent_identities_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: AgentIdentityRequest
  2. API Source: marketplace_site_agent_identities_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { marketplaceSiteAgentIdentitiesCreate } from 'waldur-js-client';

try {
  const response = await marketplaceSiteAgentIdentitiesCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "offering": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "my-awesome-marketplace-site-agent-identity"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
offering string (uuid) ✓ UUID of an offering with a site-agent compatible type.
name string ✓
version string
dependencies any
config_file_path string Example: '/etc/waldur/agent.yaml'
config_file_content string
last_restarted string (date-time)

201 -

Field Type Description
uuid string (uuid)
url string (uri)
offering string (uuid) UUID of an offering with a site-agent compatible type.
name string
version string
dependencies any
config_file_path string Example: '/etc/waldur/agent.yaml'
config_file_content string
last_restarted string (date-time)
created string (date-time)
modified string (date-time)
services array of objects
services.uuid string (uuid)
services.url string (uri)
services.name string
services.mode string
services.state any
services.statistics any
services.created string (date-time)
services.modified string (date-time)

Update

1
2
3
4
5
6
http \
  PUT \
  https://api.example.com/api/marketplace-site-agent-identities/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  offering="a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  name="my-awesome-marketplace-site-agent-identity"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.agent_identity_request import AgentIdentityRequest # (1)
from waldur_api_client.api.marketplace_site_agent_identities import marketplace_site_agent_identities_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = AgentIdentityRequest(
    offering="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    name="my-awesome-marketplace-site-agent-identity"
)
response = marketplace_site_agent_identities_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: AgentIdentityRequest
  2. API Source: marketplace_site_agent_identities_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { marketplaceSiteAgentIdentitiesUpdate } from 'waldur-js-client';

try {
  const response = await marketplaceSiteAgentIdentitiesUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "offering": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "my-awesome-marketplace-site-agent-identity"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
offering string (uuid) ✓ UUID of an offering with a site-agent compatible type.
name string ✓
version string
dependencies any
config_file_path string Example: '/etc/waldur/agent.yaml'
config_file_content string
last_restarted string (date-time)

200 -

Field Type Description
uuid string (uuid)
url string (uri)
offering string (uuid) UUID of an offering with a site-agent compatible type.
name string
version string
dependencies any
config_file_path string Example: '/etc/waldur/agent.yaml'
config_file_content string
last_restarted string (date-time)
created string (date-time)
modified string (date-time)
services array of objects
services.uuid string (uuid)
services.url string (uri)
services.name string
services.mode string
services.state any
services.statistics any
services.created string (date-time)
services.modified string (date-time)

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/marketplace-site-agent-identities/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_site_agent_identities import marketplace_site_agent_identities_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_site_agent_identities_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_site_agent_identities_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceSiteAgentIdentitiesDestroy } from 'waldur-js-client';

try {
  const response = await marketplaceSiteAgentIdentitiesDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Other Actions

Remove agent identities that have no active services. Staff only

Remove agent identities that have no active services. Staff only.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-site-agent-identities/cleanup_orphaned/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.cleanup_request_request import CleanupRequestRequest # (1)
from waldur_api_client.api.marketplace_site_agent_identities import marketplace_site_agent_identities_cleanup_orphaned # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = CleanupRequestRequest()
response = marketplace_site_agent_identities_cleanup_orphaned.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: CleanupRequestRequest
  2. API Source: marketplace_site_agent_identities_cleanup_orphaned
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceSiteAgentIdentitiesCleanupOrphaned } from 'waldur-js-client';

try {
  const response = await marketplaceSiteAgentIdentitiesCleanupOrphaned({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
dry_run boolean If true, only return what would be deleted without actually deleting
Constraints: default: True
older_than_hours integer Delete entries older than this many hours
Constraints: default: 24

200 -

Field Type Description
deleted_count integer Number of items deleted (or would be deleted in dry run)
dry_run boolean Whether this was a dry run
items array of objects List of deleted (or to-be-deleted) items

Register event subscription

Register an event subscription for the specified agent identity and observable object type. Returns existing subscription if already exists.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/marketplace-site-agent-identities/a1b2c3d4-e5f6-7890-abcd-ef1234567890/register_event_subscription/ \
  Authorization:"Token YOUR_API_TOKEN" \
  observable_object_type=null

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.agent_event_subscription_create_request import AgentEventSubscriptionCreateRequest # (1)
from waldur_api_client.api.marketplace_site_agent_identities import marketplace_site_agent_identities_register_event_subscription # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = AgentEventSubscriptionCreateRequest(
    observable_object_type=null
)
response = marketplace_site_agent_identities_register_event_subscription.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: AgentEventSubscriptionCreateRequest
  2. API Source: marketplace_site_agent_identities_register_event_subscription
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { marketplaceSiteAgentIdentitiesRegisterEventSubscription } from 'waldur-js-client';

try {
  const response = await marketplaceSiteAgentIdentitiesRegisterEventSubscription({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "observable_object_type": null
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
observable_object_type any ✓ The type of object to observe for events
description string Optional description for the event subscription

200 -

Field Type Description
uuid string (uuid)
url string (uri)
description string
user string (uri)
user_uuid string (uuid)
user_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
user_full_name string
observable_objects any List of objects to observe. Each item must have 'object_type' (one of: order, user_role, resource, offering_user, importable_resources, service_account, course_account, resource_periodic_limits) and optionally 'object_id' (integer). Example: [{"object_type": "resource"}, {"object_type": "order", "object_id": 123}]
created string (date-time)
modified string (date-time)
source_ip any An IPv4 or IPv6 address.

201 -

Field Type Description
uuid string (uuid)
url string (uri)
description string
user string (uri)
user_uuid string (uuid)
user_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
user_full_name string
observable_objects any List of objects to observe. Each item must have 'object_type' (one of: order, user_role, resource, offering_user, importable_resources, service_account, course_account, resource_periodic_limits) and optionally 'object_id' (integer). Example: [{"object_type": "resource"}, {"object_type": "order", "object_id": 123}]
created string (date-time)
modified string (date-time)
source_ip any An IPv4 or IPv6 address.

Register a new processor or get the existing one for the agent service

Register a new processor or get the existing one for the agent service

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/marketplace-site-agent-identities/a1b2c3d4-e5f6-7890-abcd-ef1234567890/register_service/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-marketplace-site-agent-identity"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.agent_service_create_request import AgentServiceCreateRequest # (1)
from waldur_api_client.api.marketplace_site_agent_identities import marketplace_site_agent_identities_register_service # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = AgentServiceCreateRequest(
    name="my-awesome-marketplace-site-agent-identity"
)
response = marketplace_site_agent_identities_register_service.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: AgentServiceCreateRequest
  2. API Source: marketplace_site_agent_identities_register_service
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { marketplaceSiteAgentIdentitiesRegisterService } from 'waldur-js-client';

try {
  const response = await marketplaceSiteAgentIdentitiesRegisterService({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-marketplace-site-agent-identity"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
name string ✓
mode string

200 -

Field Type Description
uuid string (uuid)
url string (uri)
identity string (uuid)
identity_name string
name string
mode string
state any
statistics any
created string (date-time)
modified string (date-time)
processors array of objects
processors.uuid string (uuid)
processors.url string (uri)
processors.name string
processors.last_run string (date-time)
processors.backend_type string Type of the backend, for example SLURM.
processors.backend_version string
processors.created string (date-time)
processors.modified string (date-time)

201 -

Field Type Description
uuid string (uuid)
url string (uri)
identity string (uuid)
identity_name string
name string
mode string
state any
statistics any
created string (date-time)
modified string (date-time)
processors array of objects
processors.uuid string (uuid)
processors.url string (uri)
processors.name string
processors.last_run string (date-time)
processors.backend_type string Type of the backend, for example SLURM.
processors.backend_version string
processors.created string (date-time)
processors.modified string (date-time)

Marketplace Site Agent Processors

Operations Summary

Method Endpoint Description
GET /api/marketplace-site-agent-processors/ List Marketplace Site Agent Processors
GET /api/marketplace-site-agent-processors/{uuid}/ Retrieve
DELETE /api/marketplace-site-agent-processors/{uuid}/ Delete

List Marketplace Site Agent Processors

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-site-agent-processors/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_site_agent_processors import marketplace_site_agent_processors_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_site_agent_processors_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: marketplace_site_agent_processors_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceSiteAgentProcessorsList } from 'waldur-js-client';

try {
  const response = await marketplaceSiteAgentProcessorsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
backend_type string
backend_version string
last_run string (date-time) Last run after
last_run_before string (date-time) Last run before
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
service_uuid string (uuid)
stale boolean Last run more than 1 hour ago

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid)
url string (uri)
service string (uuid)
service_name string
name string
last_run string (date-time)
backend_type string Type of the backend, for example SLURM.
backend_version string
created string (date-time)
modified string (date-time)

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-site-agent-processors/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_site_agent_processors import marketplace_site_agent_processors_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_site_agent_processors_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_site_agent_processors_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceSiteAgentProcessorsRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceSiteAgentProcessorsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
uuid string (uuid)
url string (uri)
service string (uuid)
service_name string
name string
last_run string (date-time)
backend_type string Type of the backend, for example SLURM.
backend_version string
created string (date-time)
modified string (date-time)

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/marketplace-site-agent-processors/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_site_agent_processors import marketplace_site_agent_processors_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_site_agent_processors_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_site_agent_processors_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceSiteAgentProcessorsDestroy } from 'waldur-js-client';

try {
  const response = await marketplaceSiteAgentProcessorsDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Marketplace Site Agent Services

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/marketplace-site-agent-services/ List Marketplace Site Agent Services
GET /api/marketplace-site-agent-services/{uuid}/ Retrieve
DELETE /api/marketplace-site-agent-services/{uuid}/ Delete
Other Actions
POST /api/marketplace-site-agent-services/cleanup_stale/ Remove agent services that have been inactive for a specified time. Staff only
POST /api/marketplace-site-agent-services/{uuid}/register_processor/ Register a new processor for the agent service
POST /api/marketplace-site-agent-services/{uuid}/set_statistics/ Update statistics for the agent service

Core CRUD

List Marketplace Site Agent Services

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-site-agent-services/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.agent_service_state_enum import AgentServiceStateEnum # (1)
from waldur_api_client.api.marketplace_site_agent_services import marketplace_site_agent_services_list # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_site_agent_services_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: AgentServiceStateEnum
  2. API Source: marketplace_site_agent_services_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceSiteAgentServicesList } from 'waldur-js-client';

try {
  const response = await marketplaceSiteAgentServicesList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
identity_uuid string (uuid)
mode string
modified_after string (date-time) Modified after
modified_before string (date-time) Modified before
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
stale boolean Inactive for more than 24 hours
state array

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid)
url string (uri)
identity string (uuid)
identity_name string
name string
mode string
state any
statistics any
created string (date-time)
modified string (date-time)
processors array of objects
processors.uuid string (uuid)
processors.url string (uri)
processors.name string
processors.last_run string (date-time)
processors.backend_type string Type of the backend, for example SLURM.
processors.backend_version string
processors.created string (date-time)
processors.modified string (date-time)

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-site-agent-services/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_site_agent_services import marketplace_site_agent_services_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_site_agent_services_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_site_agent_services_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceSiteAgentServicesRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceSiteAgentServicesRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
uuid string (uuid)
url string (uri)
identity string (uuid)
identity_name string
name string
mode string
state any
statistics any
created string (date-time)
modified string (date-time)
processors array of objects
processors.uuid string (uuid)
processors.url string (uri)
processors.name string
processors.last_run string (date-time)
processors.backend_type string Type of the backend, for example SLURM.
processors.backend_version string
processors.created string (date-time)
processors.modified string (date-time)

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/marketplace-site-agent-services/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_site_agent_services import marketplace_site_agent_services_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_site_agent_services_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_site_agent_services_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceSiteAgentServicesDestroy } from 'waldur-js-client';

try {
  const response = await marketplaceSiteAgentServicesDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Other Actions

Remove agent services that have been inactive for a specified time. Staff only

Remove agent services that have been inactive for a specified time. Staff only.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-site-agent-services/cleanup_stale/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.cleanup_request_request import CleanupRequestRequest # (1)
from waldur_api_client.api.marketplace_site_agent_services import marketplace_site_agent_services_cleanup_stale # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = CleanupRequestRequest()
response = marketplace_site_agent_services_cleanup_stale.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: CleanupRequestRequest
  2. API Source: marketplace_site_agent_services_cleanup_stale
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceSiteAgentServicesCleanupStale } from 'waldur-js-client';

try {
  const response = await marketplaceSiteAgentServicesCleanupStale({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
dry_run boolean If true, only return what would be deleted without actually deleting
Constraints: default: True
older_than_hours integer Delete entries older than this many hours
Constraints: default: 24

200 -

Field Type Description
deleted_count integer Number of items deleted (or would be deleted in dry run)
dry_run boolean Whether this was a dry run
items array of objects List of deleted (or to-be-deleted) items

Register a new processor for the agent service

Register a new processor for the agent service

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/marketplace-site-agent-services/a1b2c3d4-e5f6-7890-abcd-ef1234567890/register_processor/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-marketplace-site-agent-service" \
  backend_type="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.agent_processor_create_request import AgentProcessorCreateRequest # (1)
from waldur_api_client.api.marketplace_site_agent_services import marketplace_site_agent_services_register_processor # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = AgentProcessorCreateRequest(
    name="my-awesome-marketplace-site-agent-service",
    backend_type="string-value"
)
response = marketplace_site_agent_services_register_processor.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: AgentProcessorCreateRequest
  2. API Source: marketplace_site_agent_services_register_processor
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { marketplaceSiteAgentServicesRegisterProcessor } from 'waldur-js-client';

try {
  const response = await marketplaceSiteAgentServicesRegisterProcessor({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-marketplace-site-agent-service",
    "backend_type": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
name string ✓
backend_type string ✓ Type of the backend, for example SLURM.
backend_version string

200 -

Field Type Description
uuid string (uuid)
url string (uri)
service string (uuid)
service_name string
name string
last_run string (date-time)
backend_type string Type of the backend, for example SLURM.
backend_version string
created string (date-time)
modified string (date-time)

201 -

Field Type Description
uuid string (uuid)
url string (uri)
service string (uuid)
service_name string
name string
last_run string (date-time)
backend_type string Type of the backend, for example SLURM.
backend_version string
created string (date-time)
modified string (date-time)

Update statistics for the agent service

Update statistics for the agent service

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/marketplace-site-agent-services/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_statistics/ \
  Authorization:"Token YOUR_API_TOKEN" \
  statistics=null

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.agent_service_statistics_request import AgentServiceStatisticsRequest # (1)
from waldur_api_client.api.marketplace_site_agent_services import marketplace_site_agent_services_set_statistics # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = AgentServiceStatisticsRequest(
    statistics=null
)
response = marketplace_site_agent_services_set_statistics.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: AgentServiceStatisticsRequest
  2. API Source: marketplace_site_agent_services_set_statistics
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { marketplaceSiteAgentServicesSetStatistics } from 'waldur-js-client';

try {
  const response = await marketplaceSiteAgentServicesSetStatistics({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "statistics": null
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
statistics any ✓ Statistics data to be stored for the service

200 -

Field Type Description
uuid string (uuid)
url string (uri)
identity string (uuid)
identity_name string
name string
mode string
state any
statistics any
created string (date-time)
modified string (date-time)
processors array of objects
processors.uuid string (uuid)
processors.url string (uri)
processors.name string
processors.last_run string (date-time)
processors.backend_type string Type of the backend, for example SLURM.
processors.backend_version string
processors.created string (date-time)
processors.modified string (date-time)

Marketplace Site Agent Stats

Operations Summary

Method Endpoint Description
GET /api/marketplace-site-agent-stats/ List Marketplace Site Agent Stats

List Marketplace Site Agent Stats

Get aggregated statistics about agent identities, services, and processors. Support users only.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-site-agent-stats/ \
  Authorization:"Token YOUR_API_TOKEN"

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_site_agent_stats import marketplace_site_agent_stats_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_site_agent_stats_retrieve.sync(client=client)

print(response)
  1. API Source: marketplace_site_agent_stats_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceSiteAgentStatsRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceSiteAgentStatsRetrieve({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

200 -

Field Type Description
identities object (free-form) Statistics about agent identities
services object (free-form) Statistics about agent services
processors object (free-form) Statistics about agent processors

Marketplace Site Agent Task Stats

Operations Summary

Method Endpoint Description
GET /api/marketplace-site-agent-task-stats/ Get Celery task status for agent-related tasks. Support users only

Get Celery task status for agent-related tasks. Support users only.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-site-agent-task-stats/ \
  Authorization:"Token YOUR_API_TOKEN"

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_site_agent_task_stats import marketplace_site_agent_task_stats_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_site_agent_task_stats_retrieve.sync(client=client)

print(response)
  1. API Source: marketplace_site_agent_task_stats_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceSiteAgentTaskStatsRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceSiteAgentTaskStatsRetrieve({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

200 -

Field Type Description
active_tasks array of objects Currently running agent-related tasks
scheduled_tasks array of objects Scheduled agent-related tasks
reserved_tasks array of objects Reserved agent-related tasks
error string Error message if task inspection failed

Software management

Marketplace Software Catalogs

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/marketplace-software-catalogs/ List software catalogs
GET /api/marketplace-software-catalogs/{uuid}/ Retrieve a software catalog
POST /api/marketplace-software-catalogs/ Create a software catalog
POST /api/marketplace-software-catalogs/{uuid}/update_catalog/ Trigger async update for an existing catalog
PUT /api/marketplace-software-catalogs/{uuid}/ Update a software catalog
PATCH /api/marketplace-software-catalogs/{uuid}/ Partially update a software catalog
DELETE /api/marketplace-software-catalogs/{uuid}/ Delete a software catalog
Other Actions
GET /api/marketplace-software-catalogs/discover/ Discover available software catalog versions
POST /api/marketplace-software-catalogs/import_catalog/ Import a new software catalog

Core CRUD

List software catalogs

Returns a paginated list of available software catalogs, such as EESSI or Spack.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-software-catalogs/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.software_catalog_o_enum import SoftwareCatalogOEnum # (1)
from waldur_api_client.api.marketplace_software_catalogs import marketplace_software_catalogs_list # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_software_catalogs_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: SoftwareCatalogOEnum
  2. API Source: marketplace_software_catalogs_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceSoftwareCatalogsList } from 'waldur-js-client';

try {
  const response = await marketplaceSoftwareCatalogsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
name string
o array Ordering
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
version string

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
created string (date-time)
modified string (date-time)
name string Catalog name (e.g., EESSI, Spack)
version string Catalog version (e.g., 2023.06, 0.21.0)
catalog_type any Type of software catalog
catalog_type_display string
source_url string (uri) Catalog source URL
description string
metadata any Catalog-specific metadata (architecture maps, API endpoints, etc.)
auto_update_enabled boolean Whether to automatically update this catalog via scheduled tasks
last_update_attempt string (date-time)
last_successful_update string (date-time)
update_errors string
package_count integer
version_count integer
target_count integer

Retrieve a software catalog

Returns the details of a specific software catalog, including its name, version, and the number of packages it contains.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-software-catalogs/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_software_catalogs import marketplace_software_catalogs_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_software_catalogs_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_software_catalogs_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceSoftwareCatalogsRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceSoftwareCatalogsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
url string (uri)
uuid string (uuid)
created string (date-time)
modified string (date-time)
name string Catalog name (e.g., EESSI, Spack)
version string Catalog version (e.g., 2023.06, 0.21.0)
catalog_type any Type of software catalog
catalog_type_display string
source_url string (uri) Catalog source URL
description string
metadata any Catalog-specific metadata (architecture maps, API endpoints, etc.)
auto_update_enabled boolean Whether to automatically update this catalog via scheduled tasks
last_update_attempt string (date-time)
last_successful_update string (date-time)
update_errors string
package_count integer
version_count integer
target_count integer

Create a software catalog

Creates a new software catalog. Requires staff permissions.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/marketplace-software-catalogs/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-marketplace-software-catalog" \
  version="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.software_catalog_request import SoftwareCatalogRequest # (1)
from waldur_api_client.api.marketplace_software_catalogs import marketplace_software_catalogs_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = SoftwareCatalogRequest(
    name="my-awesome-marketplace-software-catalog",
    version="string-value"
)
response = marketplace_software_catalogs_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: SoftwareCatalogRequest
  2. API Source: marketplace_software_catalogs_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { marketplaceSoftwareCatalogsCreate } from 'waldur-js-client';

try {
  const response = await marketplaceSoftwareCatalogsCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "name": "my-awesome-marketplace-software-catalog",
    "version": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
name string ✓ Catalog name (e.g., EESSI, Spack)
version string ✓ Catalog version (e.g., 2023.06, 0.21.0)
catalog_type any Type of software catalog
Constraints: default: binary_runtime
source_url string (uri) Catalog source URL
description string
metadata any Catalog-specific metadata (architecture maps, API endpoints, etc.)
auto_update_enabled boolean Whether to automatically update this catalog via scheduled tasks
update_errors string

201 -

Field Type Description
url string (uri)
uuid string (uuid)
created string (date-time)
modified string (date-time)
name string Catalog name (e.g., EESSI, Spack)
version string Catalog version (e.g., 2023.06, 0.21.0)
catalog_type any Type of software catalog
catalog_type_display string
source_url string (uri) Catalog source URL
description string
metadata any Catalog-specific metadata (architecture maps, API endpoints, etc.)
auto_update_enabled boolean Whether to automatically update this catalog via scheduled tasks
last_update_attempt string (date-time)
last_successful_update string (date-time)
update_errors string
package_count integer
version_count integer
target_count integer

Trigger async update for an existing catalog

Triggers a Celery task to update the given catalog from its upstream source. Returns 202 Accepted immediately. Staff only.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/marketplace-software-catalogs/a1b2c3d4-e5f6-7890-abcd-ef1234567890/update_catalog/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-marketplace-software-catalog" \
  version="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.software_catalog_request import SoftwareCatalogRequest # (1)
from waldur_api_client.api.marketplace_software_catalogs import marketplace_software_catalogs_update_catalog # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = SoftwareCatalogRequest(
    name="my-awesome-marketplace-software-catalog",
    version="string-value"
)
response = marketplace_software_catalogs_update_catalog.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: SoftwareCatalogRequest
  2. API Source: marketplace_software_catalogs_update_catalog
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { marketplaceSoftwareCatalogsUpdateCatalog } from 'waldur-js-client';

try {
  const response = await marketplaceSoftwareCatalogsUpdateCatalog({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-marketplace-software-catalog",
    "version": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
name string ✓ Catalog name (e.g., EESSI, Spack)
version string ✓ Catalog version (e.g., 2023.06, 0.21.0)
catalog_type any Type of software catalog
Constraints: default: binary_runtime
source_url string (uri) Catalog source URL
description string
metadata any Catalog-specific metadata (architecture maps, API endpoints, etc.)
auto_update_enabled boolean Whether to automatically update this catalog via scheduled tasks
update_errors string

202 - No response body

Update a software catalog

Updates an existing software catalog. Requires staff permissions.

1
2
3
4
5
6
http \
  PUT \
  https://api.example.com/api/marketplace-software-catalogs/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-marketplace-software-catalog" \
  version="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.software_catalog_request import SoftwareCatalogRequest # (1)
from waldur_api_client.api.marketplace_software_catalogs import marketplace_software_catalogs_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = SoftwareCatalogRequest(
    name="my-awesome-marketplace-software-catalog",
    version="string-value"
)
response = marketplace_software_catalogs_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: SoftwareCatalogRequest
  2. API Source: marketplace_software_catalogs_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { marketplaceSoftwareCatalogsUpdate } from 'waldur-js-client';

try {
  const response = await marketplaceSoftwareCatalogsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-marketplace-software-catalog",
    "version": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
name string ✓ Catalog name (e.g., EESSI, Spack)
version string ✓ Catalog version (e.g., 2023.06, 0.21.0)
catalog_type any Type of software catalog
Constraints: default: binary_runtime
source_url string (uri) Catalog source URL
description string
metadata any Catalog-specific metadata (architecture maps, API endpoints, etc.)
auto_update_enabled boolean Whether to automatically update this catalog via scheduled tasks
update_errors string

200 -

Field Type Description
url string (uri)
uuid string (uuid)
created string (date-time)
modified string (date-time)
name string Catalog name (e.g., EESSI, Spack)
version string Catalog version (e.g., 2023.06, 0.21.0)
catalog_type any Type of software catalog
catalog_type_display string
source_url string (uri) Catalog source URL
description string
metadata any Catalog-specific metadata (architecture maps, API endpoints, etc.)
auto_update_enabled boolean Whether to automatically update this catalog via scheduled tasks
last_update_attempt string (date-time)
last_successful_update string (date-time)
update_errors string
package_count integer
version_count integer
target_count integer

Partially update a software catalog

Partially updates an existing software catalog. Requires staff permissions.

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/marketplace-software-catalogs/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_software_catalog_request import PatchedSoftwareCatalogRequest # (1)
from waldur_api_client.api.marketplace_software_catalogs import marketplace_software_catalogs_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedSoftwareCatalogRequest()
response = marketplace_software_catalogs_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedSoftwareCatalogRequest
  2. API Source: marketplace_software_catalogs_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceSoftwareCatalogsPartialUpdate } from 'waldur-js-client';

try {
  const response = await marketplaceSoftwareCatalogsPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
name string Catalog name (e.g., EESSI, Spack)
version string Catalog version (e.g., 2023.06, 0.21.0)
catalog_type any Type of software catalog
Constraints: default: binary_runtime
source_url string (uri) Catalog source URL
description string
metadata any Catalog-specific metadata (architecture maps, API endpoints, etc.)
auto_update_enabled boolean Whether to automatically update this catalog via scheduled tasks
update_errors string

200 -

Field Type Description
url string (uri)
uuid string (uuid)
created string (date-time)
modified string (date-time)
name string Catalog name (e.g., EESSI, Spack)
version string Catalog version (e.g., 2023.06, 0.21.0)
catalog_type any Type of software catalog
catalog_type_display string
source_url string (uri) Catalog source URL
description string
metadata any Catalog-specific metadata (architecture maps, API endpoints, etc.)
auto_update_enabled boolean Whether to automatically update this catalog via scheduled tasks
last_update_attempt string (date-time)
last_successful_update string (date-time)
update_errors string
package_count integer
version_count integer
target_count integer

Delete a software catalog

Deletes a software catalog. Requires staff permissions.

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/marketplace-software-catalogs/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_software_catalogs import marketplace_software_catalogs_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_software_catalogs_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_software_catalogs_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceSoftwareCatalogsDestroy } from 'waldur-js-client';

try {
  const response = await marketplaceSoftwareCatalogsDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Other Actions

Discover available software catalog versions

Queries upstream sources (EESSI, Spack) for available catalog versions without creating anything. Returns detected versions and whether an update is available compared to existing database records.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-software-catalogs/discover/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.software_catalog_o_enum import SoftwareCatalogOEnum # (1)
from waldur_api_client.api.marketplace_software_catalogs import marketplace_software_catalogs_discover_list # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_software_catalogs_discover_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: SoftwareCatalogOEnum
  2. API Source: marketplace_software_catalogs_discover_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceSoftwareCatalogsDiscoverList } from 'waldur-js-client';

try {
  const response = await marketplaceSoftwareCatalogsDiscoverList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
name string
o array Ordering
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
version string

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
name string
catalog_type string
latest_version string
existing boolean
existing_version string
update_available boolean

Import a new software catalog

Creates a new catalog record and triggers async data loading via Celery. Returns 202 Accepted immediately. Staff only.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/marketplace-software-catalogs/import_catalog/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="EESSI"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.software_catalog_import_request import SoftwareCatalogImportRequest # (1)
from waldur_api_client.api.marketplace_software_catalogs import marketplace_software_catalogs_import_catalog # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = SoftwareCatalogImportRequest(
    name="EESSI"
)
response = marketplace_software_catalogs_import_catalog.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: SoftwareCatalogImportRequest
  2. API Source: marketplace_software_catalogs_import_catalog
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceSoftwareCatalogsImportCatalog } from 'waldur-js-client';

try {
  const response = await marketplaceSoftwareCatalogsImportCatalog({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "name": "EESSI"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required
name string ✓

202 - No response body

Marketplace Software Packages

Operations Summary

Method Endpoint Description
GET /api/marketplace-software-packages/ List software packages
GET /api/marketplace-software-packages/{uuid}/ Retrieve a software package
POST /api/marketplace-software-packages/ Create a software package
PUT /api/marketplace-software-packages/{uuid}/ Update a software package
PATCH /api/marketplace-software-packages/{uuid}/ Partially update a software package
DELETE /api/marketplace-software-packages/{uuid}/ Delete a software package

List software packages

Returns a paginated list of software packages available in the catalogs. Can be filtered by catalog, offering, or various package attributes.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-software-packages/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.software_package_o_enum import SoftwarePackageOEnum # (1)
from waldur_api_client.api.marketplace_software_packages import marketplace_software_packages_list # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_software_packages_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: SoftwarePackageOEnum
  2. API Source: marketplace_software_packages_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceSoftwarePackagesList } from 'waldur-js-client';

try {
  const response = await marketplaceSoftwarePackagesList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
catalog_name string Filter packages by catalog name (case-insensitive partial match)
catalog_uuid string (uuid) Filter packages from a specific software catalog
catalog_version string Filter packages by catalog version (case-insensitive partial match)
cpu_family string Filter packages available for specific CPU family (e.g., x86_64, aarch64)
cpu_microarchitecture string Filter packages available for specific CPU microarchitecture (e.g., generic, zen2, haswell)
description string Filter packages by description (case-insensitive partial match)
extension_name string Filter packages having extensions with a specific name
extension_type string Filter packages having extensions of a specific type (e.g., 'python')
has_version string Filter packages that have a specific version
is_extension boolean Filter packages that are extensions of other packages
name string Filter packages by name (case-insensitive partial match)
name_exact string Filter packages by exact name (case-insensitive)
o array Ordering
offering_uuid string (uuid) Filter packages available for a specific offering
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
query string Query packages by name, description, or version (case-insensitive partial match)

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
created string (date-time)
modified string (date-time)
catalog string (uri)
name string
description string
homepage string (uri)
categories any Package categories (e.g., ['bio', 'hpc', 'build-tools'])
licenses any Software licenses (e.g., ['GPL-3.0', 'MIT'])
maintainers any Package maintainers
is_extension boolean Whether this package is an extension of another package
parent_software string (uri) Parent package for extensions (e.g., Python package within Python)
catalog_name string
catalog_version string
catalog_type string
catalog_type_display string
version_count integer
extension_count integer
versions array of objects
versions.uuid string (uuid)
versions.version string
versions.release_date string (date)
versions.targets array of objects
versions.targets.uuid string (uuid)
versions.targets.target_type string Type of target (architecture, platform, variant, etc.)
versions.targets.target_name string Target identifier (x86_64/generic, linux, variant_name, etc.)
versions.targets.target_subtype string Target subtype (microarchitecture, distribution, etc.)
versions.targets.location string Target location (CVMFS path, download URL, etc.)
versions.targets.metadata any Target-specific metadata (build options, system requirements, etc.)
versions.module object (free-form)
versions.required_modules array of anys
versions.extensions array of anys
versions.toolchain object (free-form)
versions.toolchain_families_compatibility array of anys

Retrieve a software package

Returns the details of a specific software package, including its description, homepage, and available versions.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-software-packages/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_software_packages import marketplace_software_packages_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_software_packages_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_software_packages_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceSoftwarePackagesRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceSoftwarePackagesRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
url string (uri)
uuid string (uuid)
created string (date-time)
modified string (date-time)
catalog string (uri)
name string
description string
homepage string (uri)
categories any Package categories (e.g., ['bio', 'hpc', 'build-tools'])
licenses any Software licenses (e.g., ['GPL-3.0', 'MIT'])
maintainers any Package maintainers
is_extension boolean Whether this package is an extension of another package
parent_software string (uri) Parent package for extensions (e.g., Python package within Python)
catalog_name string
catalog_version string
catalog_type string
catalog_type_display string
version_count integer
extension_count integer
versions array of objects
versions.uuid string (uuid)
versions.version string
versions.release_date string (date)
versions.targets array of objects
versions.targets.uuid string (uuid)
versions.targets.target_type string Type of target (architecture, platform, variant, etc.)
versions.targets.target_name string Target identifier (x86_64/generic, linux, variant_name, etc.)
versions.targets.target_subtype string Target subtype (microarchitecture, distribution, etc.)
versions.targets.location string Target location (CVMFS path, download URL, etc.)
versions.targets.metadata any Target-specific metadata (build options, system requirements, etc.)
versions.module object (free-form)
versions.required_modules array of anys
versions.extensions array of anys
versions.toolchain object (free-form)
versions.toolchain_families_compatibility array of anys

Create a software package

Creates a new software package within a catalog. Requires staff permissions.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/marketplace-software-packages/ \
  Authorization:"Token YOUR_API_TOKEN" \
  catalog="https://api.example.com/api/catalog/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  name="my-awesome-marketplace-software-package"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.software_package_request import SoftwarePackageRequest # (1)
from waldur_api_client.api.marketplace_software_packages import marketplace_software_packages_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = SoftwarePackageRequest(
    catalog="https://api.example.com/api/catalog/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    name="my-awesome-marketplace-software-package"
)
response = marketplace_software_packages_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: SoftwarePackageRequest
  2. API Source: marketplace_software_packages_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { marketplaceSoftwarePackagesCreate } from 'waldur-js-client';

try {
  const response = await marketplaceSoftwarePackagesCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "catalog": "https://api.example.com/api/catalog/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "name": "my-awesome-marketplace-software-package"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
catalog string (uri) ✓
name string ✓
description string
homepage string (uri)
categories any Package categories (e.g., ['bio', 'hpc', 'build-tools'])
licenses any Software licenses (e.g., ['GPL-3.0', 'MIT'])
maintainers any Package maintainers
is_extension boolean Whether this package is an extension of another package
parent_software string (uri) Parent package for extensions (e.g., Python package within Python)

201 -

Field Type Description
url string (uri)
uuid string (uuid)
created string (date-time)
modified string (date-time)
catalog string (uri)
name string
description string
homepage string (uri)
categories any Package categories (e.g., ['bio', 'hpc', 'build-tools'])
licenses any Software licenses (e.g., ['GPL-3.0', 'MIT'])
maintainers any Package maintainers
is_extension boolean Whether this package is an extension of another package
parent_software string (uri) Parent package for extensions (e.g., Python package within Python)
catalog_name string
catalog_version string
catalog_type string
catalog_type_display string
version_count integer
extension_count integer
versions array of objects
versions.uuid string (uuid)
versions.version string
versions.release_date string (date)
versions.targets array of objects
versions.targets.uuid string (uuid)
versions.targets.target_type string Type of target (architecture, platform, variant, etc.)
versions.targets.target_name string Target identifier (x86_64/generic, linux, variant_name, etc.)
versions.targets.target_subtype string Target subtype (microarchitecture, distribution, etc.)
versions.targets.location string Target location (CVMFS path, download URL, etc.)
versions.targets.metadata any Target-specific metadata (build options, system requirements, etc.)
versions.module object (free-form)
versions.required_modules array of anys
versions.extensions array of anys
versions.toolchain object (free-form)
versions.toolchain_families_compatibility array of anys

Update a software package

Updates an existing software package. Requires staff permissions.

1
2
3
4
5
6
http \
  PUT \
  https://api.example.com/api/marketplace-software-packages/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  catalog="https://api.example.com/api/catalog/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  name="my-awesome-marketplace-software-package"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.software_package_request import SoftwarePackageRequest # (1)
from waldur_api_client.api.marketplace_software_packages import marketplace_software_packages_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = SoftwarePackageRequest(
    catalog="https://api.example.com/api/catalog/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    name="my-awesome-marketplace-software-package"
)
response = marketplace_software_packages_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: SoftwarePackageRequest
  2. API Source: marketplace_software_packages_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { marketplaceSoftwarePackagesUpdate } from 'waldur-js-client';

try {
  const response = await marketplaceSoftwarePackagesUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "catalog": "https://api.example.com/api/catalog/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "name": "my-awesome-marketplace-software-package"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
catalog string (uri) ✓
name string ✓
description string
homepage string (uri)
categories any Package categories (e.g., ['bio', 'hpc', 'build-tools'])
licenses any Software licenses (e.g., ['GPL-3.0', 'MIT'])
maintainers any Package maintainers
is_extension boolean Whether this package is an extension of another package
parent_software string (uri) Parent package for extensions (e.g., Python package within Python)

200 -

Field Type Description
url string (uri)
uuid string (uuid)
created string (date-time)
modified string (date-time)
catalog string (uri)
name string
description string
homepage string (uri)
categories any Package categories (e.g., ['bio', 'hpc', 'build-tools'])
licenses any Software licenses (e.g., ['GPL-3.0', 'MIT'])
maintainers any Package maintainers
is_extension boolean Whether this package is an extension of another package
parent_software string (uri) Parent package for extensions (e.g., Python package within Python)
catalog_name string
catalog_version string
catalog_type string
catalog_type_display string
version_count integer
extension_count integer
versions array of objects
versions.uuid string (uuid)
versions.version string
versions.release_date string (date)
versions.targets array of objects
versions.targets.uuid string (uuid)
versions.targets.target_type string Type of target (architecture, platform, variant, etc.)
versions.targets.target_name string Target identifier (x86_64/generic, linux, variant_name, etc.)
versions.targets.target_subtype string Target subtype (microarchitecture, distribution, etc.)
versions.targets.location string Target location (CVMFS path, download URL, etc.)
versions.targets.metadata any Target-specific metadata (build options, system requirements, etc.)
versions.module object (free-form)
versions.required_modules array of anys
versions.extensions array of anys
versions.toolchain object (free-form)
versions.toolchain_families_compatibility array of anys

Partially update a software package

Partially updates an existing software package. Requires staff permissions.

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/marketplace-software-packages/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_software_package_request import PatchedSoftwarePackageRequest # (1)
from waldur_api_client.api.marketplace_software_packages import marketplace_software_packages_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedSoftwarePackageRequest()
response = marketplace_software_packages_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedSoftwarePackageRequest
  2. API Source: marketplace_software_packages_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceSoftwarePackagesPartialUpdate } from 'waldur-js-client';

try {
  const response = await marketplaceSoftwarePackagesPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
catalog string (uri)
name string
description string
homepage string (uri)
categories any Package categories (e.g., ['bio', 'hpc', 'build-tools'])
licenses any Software licenses (e.g., ['GPL-3.0', 'MIT'])
maintainers any Package maintainers
is_extension boolean Whether this package is an extension of another package
parent_software string (uri) Parent package for extensions (e.g., Python package within Python)

200 -

Field Type Description
url string (uri)
uuid string (uuid)
created string (date-time)
modified string (date-time)
catalog string (uri)
name string
description string
homepage string (uri)
categories any Package categories (e.g., ['bio', 'hpc', 'build-tools'])
licenses any Software licenses (e.g., ['GPL-3.0', 'MIT'])
maintainers any Package maintainers
is_extension boolean Whether this package is an extension of another package
parent_software string (uri) Parent package for extensions (e.g., Python package within Python)
catalog_name string
catalog_version string
catalog_type string
catalog_type_display string
version_count integer
extension_count integer
versions array of objects
versions.uuid string (uuid)
versions.version string
versions.release_date string (date)
versions.targets array of objects
versions.targets.uuid string (uuid)
versions.targets.target_type string Type of target (architecture, platform, variant, etc.)
versions.targets.target_name string Target identifier (x86_64/generic, linux, variant_name, etc.)
versions.targets.target_subtype string Target subtype (microarchitecture, distribution, etc.)
versions.targets.location string Target location (CVMFS path, download URL, etc.)
versions.targets.metadata any Target-specific metadata (build options, system requirements, etc.)
versions.module object (free-form)
versions.required_modules array of anys
versions.extensions array of anys
versions.toolchain object (free-form)
versions.toolchain_families_compatibility array of anys

Delete a software package

Deletes a software package. Requires staff permissions.

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/marketplace-software-packages/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_software_packages import marketplace_software_packages_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_software_packages_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_software_packages_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceSoftwarePackagesDestroy } from 'waldur-js-client';

try {
  const response = await marketplaceSoftwarePackagesDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Marketplace Software Targets

Operations Summary

Method Endpoint Description
GET /api/marketplace-software-targets/ List software targets
GET /api/marketplace-software-targets/{uuid}/ Retrieve a software target
POST /api/marketplace-software-targets/ Create a software target
PUT /api/marketplace-software-targets/{uuid}/ Update a software target
PATCH /api/marketplace-software-targets/{uuid}/ Partially update a software target
DELETE /api/marketplace-software-targets/{uuid}/ Delete a software target

List software targets

Returns a paginated list of software targets, which represent specific builds of a software version for a given CPU architecture.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-software-targets/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.software_target_o_enum import SoftwareTargetOEnum # (1)
from waldur_api_client.api.marketplace_software_targets import marketplace_software_targets_list # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_software_targets_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: SoftwareTargetOEnum
  2. API Source: marketplace_software_targets_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceSoftwareTargetsList } from 'waldur-js-client';

try {
  const response = await marketplaceSoftwareTargetsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
catalog_uuid string (uuid)
cpu_family string
cpu_microarchitecture string
o array Ordering
offering_uuid string (uuid)
package_uuid string (uuid)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
path string
version_uuid string (uuid)

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
created string (date-time)
modified string (date-time)
target_type string Type of target (architecture, platform, variant, etc.)
target_name string Target identifier (x86_64/generic, linux, variant_name, etc.)
target_subtype string Target subtype (microarchitecture, distribution, etc.)
location string Target location (CVMFS path, download URL, etc.)
metadata any Target-specific metadata (build options, system requirements, etc.)

Retrieve a software target

Returns the details of a specific software target, including its CPU family, microarchitecture, and path.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-software-targets/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_software_targets import marketplace_software_targets_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_software_targets_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_software_targets_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceSoftwareTargetsRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceSoftwareTargetsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
url string (uri)
uuid string (uuid)
created string (date-time)
modified string (date-time)
target_type string Type of target (architecture, platform, variant, etc.)
target_name string Target identifier (x86_64/generic, linux, variant_name, etc.)
target_subtype string Target subtype (microarchitecture, distribution, etc.)
location string Target location (CVMFS path, download URL, etc.)
metadata any Target-specific metadata (build options, system requirements, etc.)

Create a software target

Creates a new target for a software version. Requires staff permissions.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-software-targets/ \
  Authorization:"Token YOUR_API_TOKEN"

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_software_targets import marketplace_software_targets_create # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_software_targets_create.sync(client=client)

print(response)
  1. API Source: marketplace_software_targets_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceSoftwareTargetsCreate } from 'waldur-js-client';

try {
  const response = await marketplaceSoftwareTargetsCreate({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

201 -

Field Type Description
url string (uri)
uuid string (uuid)
created string (date-time)
modified string (date-time)
target_type string Type of target (architecture, platform, variant, etc.)
target_name string Target identifier (x86_64/generic, linux, variant_name, etc.)
target_subtype string Target subtype (microarchitecture, distribution, etc.)
location string Target location (CVMFS path, download URL, etc.)
metadata any Target-specific metadata (build options, system requirements, etc.)

Update a software target

Updates an existing software target. Requires staff permissions.

1
2
3
4
http \
  PUT \
  https://api.example.com/api/marketplace-software-targets/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_software_targets import marketplace_software_targets_update # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_software_targets_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_software_targets_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceSoftwareTargetsUpdate } from 'waldur-js-client';

try {
  const response = await marketplaceSoftwareTargetsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
url string (uri)
uuid string (uuid)
created string (date-time)
modified string (date-time)
target_type string Type of target (architecture, platform, variant, etc.)
target_name string Target identifier (x86_64/generic, linux, variant_name, etc.)
target_subtype string Target subtype (microarchitecture, distribution, etc.)
location string Target location (CVMFS path, download URL, etc.)
metadata any Target-specific metadata (build options, system requirements, etc.)

Partially update a software target

Partially updates an existing software target. Requires staff permissions.

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/marketplace-software-targets/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_software_targets import marketplace_software_targets_partial_update # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_software_targets_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_software_targets_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceSoftwareTargetsPartialUpdate } from 'waldur-js-client';

try {
  const response = await marketplaceSoftwareTargetsPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
url string (uri)
uuid string (uuid)
created string (date-time)
modified string (date-time)
target_type string Type of target (architecture, platform, variant, etc.)
target_name string Target identifier (x86_64/generic, linux, variant_name, etc.)
target_subtype string Target subtype (microarchitecture, distribution, etc.)
location string Target location (CVMFS path, download URL, etc.)
metadata any Target-specific metadata (build options, system requirements, etc.)

Delete a software target

Deletes a software target. Requires staff permissions.

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/marketplace-software-targets/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_software_targets import marketplace_software_targets_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_software_targets_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_software_targets_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceSoftwareTargetsDestroy } from 'waldur-js-client';

try {
  const response = await marketplaceSoftwareTargetsDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Marketplace Software Versions

Operations Summary

Method Endpoint Description
GET /api/marketplace-software-versions/ List software versions
GET /api/marketplace-software-versions/{uuid}/ Retrieve a software version
POST /api/marketplace-software-versions/ Create a software version
PUT /api/marketplace-software-versions/{uuid}/ Update a software version
PATCH /api/marketplace-software-versions/{uuid}/ Partially update a software version
DELETE /api/marketplace-software-versions/{uuid}/ Delete a software version

List software versions

Returns a paginated list of software versions. Can be filtered by package, catalog, offering, or CPU architecture.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-software-versions/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.software_version_o_enum import SoftwareVersionOEnum # (1)
from waldur_api_client.api.marketplace_software_versions import marketplace_software_versions_list # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_software_versions_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: SoftwareVersionOEnum
  2. API Source: marketplace_software_versions_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceSoftwareVersionsList } from 'waldur-js-client';

try {
  const response = await marketplaceSoftwareVersionsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
catalog_uuid string (uuid)
cpu_family string
cpu_microarchitecture string
o array Ordering
offering_uuid string (uuid)
package_name string
package_uuid string (uuid)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
version string

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
created string (date-time)
modified string (date-time)
version string
release_date string (date)
dependencies any Package dependencies (format varies by catalog type)
metadata any Version-specific metadata (toolchains, build info, modules, etc.)
package_name string
catalog_type string
target_count integer
module object (free-form)
required_modules array of anys
extensions array of anys
toolchain object (free-form)
toolchain_families_compatibility array of anys

Retrieve a software version

Returns the details of a specific software version, including its release date and target count.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-software-versions/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_software_versions import marketplace_software_versions_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_software_versions_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_software_versions_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceSoftwareVersionsRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceSoftwareVersionsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
url string (uri)
uuid string (uuid)
created string (date-time)
modified string (date-time)
version string
release_date string (date)
dependencies any Package dependencies (format varies by catalog type)
metadata any Version-specific metadata (toolchains, build info, modules, etc.)
package_name string
catalog_type string
target_count integer
module object (free-form)
required_modules array of anys
extensions array of anys
toolchain object (free-form)
toolchain_families_compatibility array of anys

Create a software version

Creates a new version for a software package. Requires staff permissions.

1
2
3
4
http \
  POST \
  https://api.example.com/api/marketplace-software-versions/ \
  Authorization:"Token YOUR_API_TOKEN"

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_software_versions import marketplace_software_versions_create # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_software_versions_create.sync(client=client)

print(response)
  1. API Source: marketplace_software_versions_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceSoftwareVersionsCreate } from 'waldur-js-client';

try {
  const response = await marketplaceSoftwareVersionsCreate({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

201 -

Field Type Description
url string (uri)
uuid string (uuid)
created string (date-time)
modified string (date-time)
version string
release_date string (date)
dependencies any Package dependencies (format varies by catalog type)
metadata any Version-specific metadata (toolchains, build info, modules, etc.)
package_name string
catalog_type string
target_count integer
module object (free-form)
required_modules array of anys
extensions array of anys
toolchain object (free-form)
toolchain_families_compatibility array of anys

Update a software version

Updates an existing software version. Requires staff permissions.

1
2
3
4
http \
  PUT \
  https://api.example.com/api/marketplace-software-versions/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_software_versions import marketplace_software_versions_update # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_software_versions_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_software_versions_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceSoftwareVersionsUpdate } from 'waldur-js-client';

try {
  const response = await marketplaceSoftwareVersionsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
url string (uri)
uuid string (uuid)
created string (date-time)
modified string (date-time)
version string
release_date string (date)
dependencies any Package dependencies (format varies by catalog type)
metadata any Version-specific metadata (toolchains, build info, modules, etc.)
package_name string
catalog_type string
target_count integer
module object (free-form)
required_modules array of anys
extensions array of anys
toolchain object (free-form)
toolchain_families_compatibility array of anys

Partially update a software version

Partially updates an existing software version. Requires staff permissions.

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/marketplace-software-versions/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_software_versions import marketplace_software_versions_partial_update # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_software_versions_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_software_versions_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceSoftwareVersionsPartialUpdate } from 'waldur-js-client';

try {
  const response = await marketplaceSoftwareVersionsPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
url string (uri)
uuid string (uuid)
created string (date-time)
modified string (date-time)
version string
release_date string (date)
dependencies any Package dependencies (format varies by catalog type)
metadata any Version-specific metadata (toolchains, build info, modules, etc.)
package_name string
catalog_type string
target_count integer
module object (free-form)
required_modules array of anys
extensions array of anys
toolchain object (free-form)
toolchain_families_compatibility array of anys

Delete a software version

Deletes a software version. Requires staff permissions.

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/marketplace-software-versions/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_software_versions import marketplace_software_versions_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_software_versions_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_software_versions_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceSoftwareVersionsDestroy } from 'waldur-js-client';

try {
  const response = await marketplaceSoftwareVersionsDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Usage and stats

Marketplace Category Component Usages

Operations Summary

Method Endpoint Description
GET /api/marketplace-category-component-usages/ List aggregated category component usages
GET /api/marketplace-category-component-usages/{id}/ Retrieve an aggregated category component usage record

List aggregated category component usages

1
2
3
4
5
6
    Returns a paginated list of aggregated component usages for marketplace categories.
    This data is scoped to either a customer or a project and represents the total usage
    of a component type (e.g., total 'CPU hours' used across all resources of a certain category
    within a project).

    The list **must** be filtered by a `scope` parameter (either a customer or project URL).

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-category-component-usages/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.category_component_usage_field_enum import CategoryComponentUsageFieldEnum # (1)
from waldur_api_client.api.marketplace_category_component_usages import marketplace_category_component_usages_list # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_category_component_usages_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: CategoryComponentUsageFieldEnum
  2. API Source: marketplace_category_component_usages_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceCategoryComponentUsagesList } from 'waldur-js-client';

try {
  const response = await marketplaceCategoryComponentUsagesList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
date_after string (date) Date after or equal to
date_before string (date) Date before or equal to
field array
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
scope string (uri) Filter by scope URL.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
name string Display name for the measured unit, for example, Floating IP.
type string Unique internal name of the measured unit, for example floating_ip.
measured_unit string Unit of measurement, for example, GB.
category_title string
category_uuid string (uuid)
date string (date)
reported_usage integer (int64)
fixed_usage integer (int64)
scope string

Retrieve an aggregated category component usage record

Returns the details of a single aggregated usage record for a category component, identified by its database ID.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-category-component-usages/123/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.category_component_usage_field_enum import CategoryComponentUsageFieldEnum # (1)
from waldur_api_client.api.marketplace_category_component_usages import marketplace_category_component_usages_retrieve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_category_component_usages_retrieve.sync(
    id=123,
    client=client
)

print(response)
  1. Model Source: CategoryComponentUsageFieldEnum
  2. API Source: marketplace_category_component_usages_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceCategoryComponentUsagesRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceCategoryComponentUsagesRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "id": 123
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
id integer ✓ A unique integer value identifying this category component usage.
Name Type
field array

200 -

Field Type Description
name string Display name for the measured unit, for example, Floating IP.
type string Unique internal name of the measured unit, for example floating_ip.
measured_unit string Unit of measurement, for example, GB.
category_title string
category_uuid string (uuid)
date string (date)
reported_usage integer (int64)
fixed_usage integer (int64)
scope string

Marketplace Component Usages

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/marketplace-component-usages/ List component usage records
GET /api/marketplace-component-usages/{uuid}/ Retrieve a component usage record
Other Actions
POST /api/marketplace-component-usages/set_usage/ Set component usage for a resource
POST /api/marketplace-component-usages/{uuid}/set_user_usage/ Set user-specific component usage
POST /api/marketplace-component-usages/{uuid}/set_user_usages/ Bulk set user-specific component usages

Core CRUD

List component usage records

Returns a paginated list of component usage records for resources. This data is used for billing and usage tracking.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-component-usages/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.component_usage_field_enum import ComponentUsageFieldEnum # (1)
from waldur_api_client.models.component_usage_o_enum import ComponentUsageOEnum # (2)
from waldur_api_client.api.marketplace_component_usages import marketplace_component_usages_list # (3)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_component_usages_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: ComponentUsageFieldEnum
  2. Model Source: ComponentUsageOEnum
  3. API Source: marketplace_component_usages_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceComponentUsagesList } from 'waldur-js-client';

try {
  const response = await marketplaceComponentUsagesList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
billing_period string (date)
billing_period_month number Billing period month
billing_period_year number Billing period year
customer_uuid string (uuid) Customer UUID
date_after string (date) Date after or equal to
date_before string (date) Date before or equal to
field array
o array Ordering
offering_uuid string (uuid) Offering UUID
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
project_uuid string (uuid) Project UUID
resource string (uri) Resource URL
resource_uuid string (uuid) Resource UUID
type string Component type

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid)
created string (date-time)
description string
type string Unique internal name of the measured unit, for example floating_ip.
name string Display name for the measured unit, for example, Floating IP.
measured_unit string Unit of measurement, for example, GB.
usage integer
date string (date-time)
recurring boolean Reported value is reused every month until changed.
resource_name string
resource_uuid string (uuid)
offering_name string
offering_uuid string (uuid)
project_name string
project_uuid string
customer_name string
customer_uuid string
billing_period string (date)
modified_by integer

Retrieve a component usage record

Returns the details of a specific component usage record.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-component-usages/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.component_usage_field_enum import ComponentUsageFieldEnum # (1)
from waldur_api_client.api.marketplace_component_usages import marketplace_component_usages_retrieve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_component_usages_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. Model Source: ComponentUsageFieldEnum
  2. API Source: marketplace_component_usages_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceComponentUsagesRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceComponentUsagesRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type
field array

200 -

Field Type Description
uuid string (uuid)
created string (date-time)
description string
type string Unique internal name of the measured unit, for example floating_ip.
name string Display name for the measured unit, for example, Floating IP.
measured_unit string Unit of measurement, for example, GB.
usage integer
date string (date-time)
recurring boolean Reported value is reused every month until changed.
resource_name string
resource_uuid string (uuid)
offering_name string
offering_uuid string (uuid)
project_name string
project_uuid string
customer_name string
customer_uuid string
billing_period string (date)
modified_by integer

Other Actions

Set component usage for a resource

1
2
3
4
5
6
    Allows a service provider to report usage for one or more components of a specific resource.
    This endpoint is typically used by backend systems or agents to submit periodic usage data.

    - If a `plan_period` is provided, the usage is associated with that period.
    - If only a `resource` is provided, the system will determine the correct plan period based on the current date.
    - If a usage record for the same resource, component, and billing period already exists, it will be updated. Otherwise, a new record is created.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/marketplace-component-usages/set_usage/ \
  Authorization:"Token YOUR_API_TOKEN" \
  usages:='[]'

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.component_usage_create_request import ComponentUsageCreateRequest # (1)
from waldur_api_client.api.marketplace_component_usages import marketplace_component_usages_set_usage # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ComponentUsageCreateRequest(
    usages=[]
)
response = marketplace_component_usages_set_usage.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ComponentUsageCreateRequest
  2. API Source: marketplace_component_usages_set_usage
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceComponentUsagesSetUsage } from 'waldur-js-client';

try {
  const response = await marketplaceComponentUsagesSetUsage({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "usages": []
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
usages array of objects ✓ List of component usage items to report
usages.type string ✓ Type of the component
usages.amount string (decimal) ✓ Usage amount
usages.description string Optional description of usage
usages.recurring boolean Whether this usage is recurring
Constraints: default: False
plan_period string (uuid) UUID of the specific resource plan period for usage reporting
resource string (uuid) UUID of the resource for usage reporting (required if plan_period not provided)
date string (date-time) Date for usage reporting (staff and service providers for limit-based components). If not provided, current date is used.

201 - No response body

Set user-specific component usage

1
2
3
4
5
    Allows a service provider to report usage for a specific user associated with a resource's component.
    This is used for detailed, per-user usage tracking within a single resource.

    - If a user-specific usage record already exists for the given component usage, it will be updated.
    - Otherwise, a new record is created.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/marketplace-component-usages/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_user_usage/ \
  Authorization:"Token YOUR_API_TOKEN" \
  username="alice"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.component_user_usage_create_request import ComponentUserUsageCreateRequest # (1)
from waldur_api_client.api.marketplace_component_usages import marketplace_component_usages_set_user_usage # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ComponentUserUsageCreateRequest(
    username="alice"
)
response = marketplace_component_usages_set_user_usage.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ComponentUserUsageCreateRequest
  2. API Source: marketplace_component_usages_set_user_usage
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { marketplaceComponentUsagesSetUserUsage } from 'waldur-js-client';

try {
  const response = await marketplaceComponentUsagesSetUserUsage({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "username": "alice"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
usage string (decimal)
username string ✓
user string (uri)
date string (date-time) Date for usage reporting (staff and service providers for limit-based components). If not provided, current date is used.

201 - No response body

Bulk set user-specific component usages

1
2
3
4
5
6
    Allows a service provider to report usage for multiple users associated with a resource's component
    in a single request. This avoids the need for one API call per user.

    - All usages are processed atomically: if any item fails validation, none are persisted.
    - If a user-specific usage record already exists for the given component usage, it will be updated.
    - Otherwise, a new record is created.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/marketplace-component-usages/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_user_usages/ \
  Authorization:"Token YOUR_API_TOKEN" \
  usages:='[]'

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.component_user_usage_bulk_create_request import ComponentUserUsageBulkCreateRequest # (1)
from waldur_api_client.api.marketplace_component_usages import marketplace_component_usages_set_user_usages # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ComponentUserUsageBulkCreateRequest(
    usages=[]
)
response = marketplace_component_usages_set_user_usages.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ComponentUserUsageBulkCreateRequest
  2. API Source: marketplace_component_usages_set_user_usages
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { marketplaceComponentUsagesSetUserUsages } from 'waldur-js-client';

try {
  const response = await marketplaceComponentUsagesSetUserUsages({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "usages": []
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
usages array of objects ✓
usages.usage string (decimal)
usages.username string ✓
usages.user string (uri)
usages.date string (date-time) Date for usage reporting (staff and service providers for limit-based components). If not provided, current date is used.

201 - No response body

Component User Usage Limits

Operations Summary

Method Endpoint Description
GET /api/component-user-usage-limits/ List component usage limits for users
GET /api/component-user-usage-limits/{uuid}/ Retrieve a component usage limit
POST /api/component-user-usage-limits/ Create a component usage limit for a user
PUT /api/component-user-usage-limits/{uuid}/ Update a component usage limit
PATCH /api/component-user-usage-limits/{uuid}/ Partially update a component usage limit
DELETE /api/component-user-usage-limits/{uuid}/ Delete a component usage limit

List component usage limits for users

Returns a paginated list of usage limits set for specific users on resource components.

1
2
3
4
http \
  GET \
  https://api.example.com/api/component-user-usage-limits/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.component_user_usage_limits import component_user_usage_limits_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = component_user_usage_limits_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: component_user_usage_limits_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { componentUserUsageLimitsList } from 'waldur-js-client';

try {
  const response = await componentUserUsageLimitsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
component_type string Component type
offering_uuid string (uuid) Offering UUID
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
resource string (uri) Resource URL
resource_uuid string (uuid) Resource UUID
username string Username

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
resource string (uri)
component string (uuid)
component_type string Unique internal name of the measured unit, for example floating_ip.
user string (uri)
limit string (decimal)

Retrieve a component usage limit

Returns the details of a specific user's usage limit for a component.

1
2
3
4
http \
  GET \
  https://api.example.com/api/component-user-usage-limits/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.component_user_usage_limits import component_user_usage_limits_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = component_user_usage_limits_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: component_user_usage_limits_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { componentUserUsageLimitsRetrieve } from 'waldur-js-client';

try {
  const response = await componentUserUsageLimitsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
url string (uri)
uuid string (uuid)
resource string (uri)
component string (uuid)
component_type string Unique internal name of the measured unit, for example floating_ip.
user string (uri)
limit string (decimal)

Create a component usage limit for a user

Sets a usage limit for a specific user on a resource's component. This is only applicable for offerings that support per-user consumption limitation.

1
2
3
4
5
6
7
http \
  POST \
  https://api.example.com/api/component-user-usage-limits/ \
  Authorization:"Token YOUR_API_TOKEN" \
  resource="https://api.example.com/api/resource/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  component="a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  user="https://api.example.com/api/user/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.component_user_usage_limit_request import ComponentUserUsageLimitRequest # (1)
from waldur_api_client.api.component_user_usage_limits import component_user_usage_limits_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ComponentUserUsageLimitRequest(
    resource="https://api.example.com/api/resource/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    component="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    user="https://api.example.com/api/user/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = component_user_usage_limits_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ComponentUserUsageLimitRequest
  2. API Source: component_user_usage_limits_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
import { componentUserUsageLimitsCreate } from 'waldur-js-client';

try {
  const response = await componentUserUsageLimitsCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "resource": "https://api.example.com/api/resource/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "component": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "user": "https://api.example.com/api/user/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required
resource string (uri) ✓
component string (uuid) ✓
user string (uri) ✓
limit string (decimal)

201 -

Field Type Description
url string (uri)
uuid string (uuid)
resource string (uri)
component string (uuid)
component_type string Unique internal name of the measured unit, for example floating_ip.
user string (uri)
limit string (decimal)

Update a component usage limit

Updates an existing usage limit for a user on a component.

1
2
3
4
5
6
7
http \
  PUT \
  https://api.example.com/api/component-user-usage-limits/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  resource="https://api.example.com/api/resource/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  component="a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  user="https://api.example.com/api/user/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.component_user_usage_limit_request import ComponentUserUsageLimitRequest # (1)
from waldur_api_client.api.component_user_usage_limits import component_user_usage_limits_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ComponentUserUsageLimitRequest(
    resource="https://api.example.com/api/resource/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    component="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    user="https://api.example.com/api/user/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = component_user_usage_limits_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ComponentUserUsageLimitRequest
  2. API Source: component_user_usage_limits_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
import { componentUserUsageLimitsUpdate } from 'waldur-js-client';

try {
  const response = await componentUserUsageLimitsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "resource": "https://api.example.com/api/resource/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "component": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "user": "https://api.example.com/api/user/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
resource string (uri) ✓
component string (uuid) ✓
user string (uri) ✓
limit string (decimal)

200 -

Field Type Description
url string (uri)
uuid string (uuid)
resource string (uri)
component string (uuid)
component_type string Unique internal name of the measured unit, for example floating_ip.
user string (uri)
limit string (decimal)

Partially update a component usage limit

Partially updates an existing usage limit for a user on a component.

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/component-user-usage-limits/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_component_user_usage_limit_request import PatchedComponentUserUsageLimitRequest # (1)
from waldur_api_client.api.component_user_usage_limits import component_user_usage_limits_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedComponentUserUsageLimitRequest()
response = component_user_usage_limits_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedComponentUserUsageLimitRequest
  2. API Source: component_user_usage_limits_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { componentUserUsageLimitsPartialUpdate } from 'waldur-js-client';

try {
  const response = await componentUserUsageLimitsPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
resource string (uri)
component string (uuid)
user string (uri)
limit string (decimal)

200 -

Field Type Description
url string (uri)
uuid string (uuid)
resource string (uri)
component string (uuid)
component_type string Unique internal name of the measured unit, for example floating_ip.
user string (uri)
limit string (decimal)

Delete a component usage limit

Removes a usage limit for a user on a component.

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/component-user-usage-limits/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.component_user_usage_limits import component_user_usage_limits_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = component_user_usage_limits_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: component_user_usage_limits_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { componentUserUsageLimitsDestroy } from 'waldur-js-client';

try {
  const response = await componentUserUsageLimitsDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Marketplace Component User Usages

Operations Summary

Method Endpoint Description
GET /api/marketplace-component-user-usages/ List user-specific component usages
GET /api/marketplace-component-user-usages/{uuid}/ Retrieve a user-specific component usage record

List user-specific component usages

1
2
3
    Returns a paginated list of component usage records attributed to specific users.
    This provides a granular view of resource consumption, breaking down the total usage of a component
    by individual users.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-component-user-usages/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.component_user_usage_field_enum import ComponentUserUsageFieldEnum # (1)
from waldur_api_client.models.component_user_usage_o_enum import ComponentUserUsageOEnum # (2)
from waldur_api_client.api.marketplace_component_user_usages import marketplace_component_user_usages_list # (3)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_component_user_usages_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: ComponentUserUsageFieldEnum
  2. Model Source: ComponentUserUsageOEnum
  3. API Source: marketplace_component_user_usages_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceComponentUserUsagesList } from 'waldur-js-client';

try {
  const response = await marketplaceComponentUserUsagesList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
billing_period_month number Billing period month
billing_period_year number Billing period year
component_usage__billing_period string (date)
customer_uuid string (uuid) Customer UUID
date_after string (date) Date after or equal to
date_before string (date) Date before or equal .google/docsto
field array
o array Ordering
offering_uuid string (uuid) Offering UUID
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
project_uuid string (uuid) Project UUID
resource string (uri) Resource URL
resource_uuid string (uuid) Resource UUID
type string Component type
username string Username contains

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid)
user string (uri)
username string
component_usage string (uri)
usage integer
measured_unit string Unit of measurement, for example, GB.
description string
created string (date-time)
modified string (date-time)
backend_id string
resource_name string
resource_uuid string (uuid)
offering_name string
offering_uuid string (uuid)
project_name string
project_uuid string (uuid)
customer_name string
customer_uuid string (uuid)
component_type string Unique internal name of the measured unit, for example floating_ip.
date string (date-time)
billing_period string (date)

Retrieve a user-specific component usage record

Returns the details of a single user-specific component usage record.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-component-user-usages/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.component_user_usage_field_enum import ComponentUserUsageFieldEnum # (1)
from waldur_api_client.api.marketplace_component_user_usages import marketplace_component_user_usages_retrieve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_component_user_usages_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. Model Source: ComponentUserUsageFieldEnum
  2. API Source: marketplace_component_user_usages_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceComponentUserUsagesRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceComponentUserUsagesRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type
field array

200 -

Field Type Description
uuid string (uuid)
user string (uri)
username string
component_usage string (uri)
usage integer
measured_unit string Unit of measurement, for example, GB.
description string
created string (date-time)
modified string (date-time)
backend_id string
resource_name string
resource_uuid string (uuid)
offering_name string
offering_uuid string (uuid)
project_name string
project_uuid string (uuid)
customer_name string
customer_uuid string (uuid)
component_type string Unique internal name of the measured unit, for example floating_ip.
date string (date-time)
billing_period string (date)

Marketplace Stats

Operations Summary

Method Endpoint Description
GET /api/marketplace-stats/aggregated_usage_trends/ Return aggregated usage trends per month
GET /api/marketplace-stats/component_usages/ Return component usages for current month
GET /api/marketplace-stats/component_usages_per_month/ Return component usages per month
GET /api/marketplace-stats/component_usages_per_project/ Return component usages per project
GET /api/marketplace-stats/count_active_resources_grouped_by_offering_country/ Count active resources grouped by offering country
GET /api/marketplace-stats/count_active_resources_grouped_by_offering/ Count active resources grouped by offering
GET /api/marketplace-stats/count_active_resources_grouped_by_organization_group/ Count active resources grouped by organization group
GET /api/marketplace-stats/count_projects_grouped_by_provider_and_industry_flag/ Count projects grouped by provider and industry flag
GET /api/marketplace-stats/count_projects_grouped_by_provider_and_oecd/ Count projects grouped by provider and OECD code
GET /api/marketplace-stats/count_projects_of_service_providers_grouped_by_oecd/ Count projects of service providers grouped by OECD
GET /api/marketplace-stats/count_projects_of_service_providers/ Count projects of service providers
GET /api/marketplace-stats/count_unique_users_connected_with_active_resources_of_service_provider/ Count unique users connected with active resources of service provider
GET /api/marketplace-stats/count_users_of_service_providers/ Count users of service providers
GET /api/marketplace-stats/customer_member_count/ Return count of customer members
GET /api/marketplace-stats/customer_member_summary/ Return summary statistics for customer members
GET /api/marketplace-stats/offering_costs_summary/ Return summary statistics for offering costs
GET /api/marketplace-stats/offerings_counter_stats/ Offerings counter stats
GET /api/marketplace-stats/order_stats/ Order stats
GET /api/marketplace-stats/organization_project_count/ Return project count per organization
GET /api/marketplace-stats/organization_resource_count/ Return resource count per organization
GET /api/marketplace-stats/project_classification_summary/ Return summary statistics for project classification
GET /api/marketplace-stats/projects_limits_grouped_by_industry_flag/ Group project limits by industry flag
GET /api/marketplace-stats/projects_limits_grouped_by_oecd/ Group project limits by OECD code
GET /api/marketplace-stats/projects_usages_grouped_by_industry_flag/ Group project usages by industry flag
GET /api/marketplace-stats/projects_usages_grouped_by_oecd/ Group project usages by OECD code
GET /api/marketplace-stats/provider_customers/ Return customer statistics for a service provider
GET /api/marketplace-stats/provider_offerings/ Return offering performance statistics for a service provider
GET /api/marketplace-stats/provider_resources/ Return resource statistics for a service provider
GET /api/marketplace-stats/resource_provisioning_stats/ Get resource provisioning statistics
GET /api/marketplace-stats/resource_usage_by_creator_affiliation/ Return resource usage grouped by creator's affiliation
GET /api/marketplace-stats/resource_usage_by_customer/ Return resource usage statistics grouped by customer
GET /api/marketplace-stats/resource_usage_by_organization_type/ Return component usages grouped by project members' organization type
GET /api/marketplace-stats/resources_geography_summary/ Return summary statistics for resource geographic distribution
GET /api/marketplace-stats/resources_limits/ Return resources limits per offering
GET /api/marketplace-stats/resources_missing_usage/ Resources missing usage
GET /api/marketplace-stats/total_cost_of_active_resources_per_offering/ Total cost of active resources per offering
GET /api/marketplace-stats/user_affiliation_count/ Return user count grouped by affiliation
GET /api/marketplace-stats/user_auth_method_count/ Return user count grouped by authentication method
GET /api/marketplace-stats/user_identity_source_count/ Return user count grouped by identity source
GET /api/marketplace-stats/user_job_title_count/ Return user count grouped by job title
GET /api/marketplace-stats/user_organization_count/ Return user count grouped by organization
GET /api/marketplace-stats/user_organization_type_count/ Return user count grouped by organization type (SCHAC URN)

Return aggregated usage trends per month.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-stats/aggregated_usage_trends/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_stats import marketplace_stats_aggregated_usage_trends_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_stats_aggregated_usage_trends_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: marketplace_stats_aggregated_usage_trends_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceStatsAggregatedUsageTrendsList } from 'waldur-js-client';

try {
  const response = await marketplaceStatsAggregatedUsageTrendsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
period string Period in YYYY-MM format
year integer Year
month integer Month (1-12)
total_usage string (decimal) Total usage across all components
resource_count integer Number of distinct resources with usage
component_count integer Number of component usage records

Return component usages for current month

Return component usages for current month.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-stats/component_usages/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_stats import marketplace_stats_component_usages_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_stats_component_usages_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: marketplace_stats_component_usages_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceStatsComponentUsagesList } from 'waldur-js-client';

try {
  const response = await marketplaceStatsComponentUsagesList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
usage string (decimal) Total usage amount
offering_uuid string (uuid) UUID of the offering
component_type string Type of the component
offering_country string Country of the offering
organization_group_name string Name of the organization group
organization_group_uuid string UUID of the organization group

Return component usages per month

Return component usages per month.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-stats/component_usages_per_month/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_stats import marketplace_stats_component_usages_per_month_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_stats_component_usages_per_month_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: marketplace_stats_component_usages_per_month_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceStatsComponentUsagesPerMonthList } from 'waldur-js-client';

try {
  const response = await marketplaceStatsComponentUsagesPerMonthList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
usage string (decimal) Total usage amount
offering_uuid string (uuid) UUID of the offering
component_type string Type of the component
offering_country string Country of the offering
organization_group_name string Name of the organization group
organization_group_uuid string UUID of the organization group
month integer Month of the billing period
year integer Year of the billing period

Return component usages per project

Return component usages per project.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-stats/component_usages_per_project/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_stats import marketplace_stats_component_usages_per_project_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_stats_component_usages_per_project_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: marketplace_stats_component_usages_per_project_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceStatsComponentUsagesPerProjectList } from 'waldur-js-client';

try {
  const response = await marketplaceStatsComponentUsagesPerProjectList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
project_uuid string (uuid) UUID of the project
component_type string Type of the component
usage integer Total usage for the component

Count active resources grouped by offering country

Count active resources grouped by offering country.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-stats/count_active_resources_grouped_by_offering_country/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_stats import marketplace_stats_count_active_resources_grouped_by_offering_country_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_stats_count_active_resources_grouped_by_offering_country_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: marketplace_stats_count_active_resources_grouped_by_offering_country_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceStatsCountActiveResourcesGroupedByOfferingCountryList } from 'waldur-js-client';

try {
  const response = await marketplaceStatsCountActiveResourcesGroupedByOfferingCountryList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
country string Country code of the offering
count integer Number of offerings in this country

Count active resources grouped by offering

Count active resources grouped by offering.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-stats/count_active_resources_grouped_by_offering/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_stats import marketplace_stats_count_active_resources_grouped_by_offering_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_stats_count_active_resources_grouped_by_offering_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: marketplace_stats_count_active_resources_grouped_by_offering_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceStatsCountActiveResourcesGroupedByOfferingList } from 'waldur-js-client';

try {
  const response = await marketplaceStatsCountActiveResourcesGroupedByOfferingList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
count integer Number of resources for the offering
name string Name of the offering
uuid string UUID of the offering
country string Country of the offering

Count active resources grouped by organization group

Count active resources grouped by organization group.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-stats/count_active_resources_grouped_by_organization_group/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_stats import marketplace_stats_count_active_resources_grouped_by_organization_group_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_stats_count_active_resources_grouped_by_organization_group_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: marketplace_stats_count_active_resources_grouped_by_organization_group_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceStatsCountActiveResourcesGroupedByOrganizationGroupList } from 'waldur-js-client';

try {
  const response = await marketplaceStatsCountActiveResourcesGroupedByOrganizationGroupList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
name string Name from the record
uuid string UUID from the record
count integer Count value from the record

Count projects grouped by provider and industry flag

Count projects grouped by provider and industry flag

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-stats/count_projects_grouped_by_provider_and_industry_flag/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_stats import marketplace_stats_count_projects_grouped_by_provider_and_industry_flag_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_stats_count_projects_grouped_by_provider_and_industry_flag_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: marketplace_stats_count_projects_grouped_by_provider_and_industry_flag_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceStatsCountProjectsGroupedByProviderAndIndustryFlagList } from 'waldur-js-client';

try {
  const response = await marketplaceStatsCountProjectsGroupedByProviderAndIndustryFlagList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
name string Name from the record
uuid string UUID from the record
count integer Count value from the record
abbreviation string Customer abbreviation from the record
is_industry string Industry classification flag

Count projects grouped by provider and OECD code

Count projects grouped by provider and OECD code

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-stats/count_projects_grouped_by_provider_and_oecd/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_stats import marketplace_stats_count_projects_grouped_by_provider_and_oecd_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_stats_count_projects_grouped_by_provider_and_oecd_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: marketplace_stats_count_projects_grouped_by_provider_and_oecd_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceStatsCountProjectsGroupedByProviderAndOecdList } from 'waldur-js-client';

try {
  const response = await marketplaceStatsCountProjectsGroupedByProviderAndOecdList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
name string Name from the record
uuid string UUID from the record
count integer Count value from the record
abbreviation string Customer abbreviation from the record
oecd string

Count projects of service providers grouped by OECD

Count projects of service providers grouped by OECD.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-stats/count_projects_of_service_providers_grouped_by_oecd/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_stats import marketplace_stats_count_projects_of_service_providers_grouped_by_oecd_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_stats_count_projects_of_service_providers_grouped_by_oecd_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: marketplace_stats_count_projects_of_service_providers_grouped_by_oecd_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceStatsCountProjectsOfServiceProvidersGroupedByOecdList } from 'waldur-js-client';

try {
  const response = await marketplaceStatsCountProjectsOfServiceProvidersGroupedByOecdList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
service_provider_uuid string (uuid) UUID of the service provider
customer_uuid string (uuid) UUID of the customer
customer_name string Name of the customer
customer_organization_group_uuid string UUID of the customer's organization group
customer_organization_group_name string Name of the customer's organization group
count integer Count value
oecd_fos_2007_name string

Count projects of service providers

Count projects of service providers.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-stats/count_projects_of_service_providers/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_stats import marketplace_stats_count_projects_of_service_providers_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_stats_count_projects_of_service_providers_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: marketplace_stats_count_projects_of_service_providers_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceStatsCountProjectsOfServiceProvidersList } from 'waldur-js-client';

try {
  const response = await marketplaceStatsCountProjectsOfServiceProvidersList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
service_provider_uuid string (uuid) UUID of the service provider
customer_uuid string (uuid) UUID of the customer
customer_name string Name of the customer
customer_organization_group_uuid string UUID of the customer's organization group
customer_organization_group_name string Name of the customer's organization group
count integer Count value

Count unique users connected with active resources of service provider

Count unique users connected with active resources of service provider.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-stats/count_unique_users_connected_with_active_resources_of_service_provider/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_stats import marketplace_stats_count_unique_users_connected_with_active_resources_of_service_provider_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_stats_count_unique_users_connected_with_active_resources_of_service_provider_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: marketplace_stats_count_unique_users_connected_with_active_resources_of_service_provider_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceStatsCountUniqueUsersConnectedWithActiveResourcesOfServiceProviderList } from 'waldur-js-client';

try {
  const response = await marketplaceStatsCountUniqueUsersConnectedWithActiveResourcesOfServiceProviderList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
customer_uuid string (uuid) UUID of the customer
customer_name string Name of the customer
count_users integer Number of unique users

Count users of service providers

Count users of service providers.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-stats/count_users_of_service_providers/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_stats import marketplace_stats_count_users_of_service_providers_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_stats_count_users_of_service_providers_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: marketplace_stats_count_users_of_service_providers_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceStatsCountUsersOfServiceProvidersList } from 'waldur-js-client';

try {
  const response = await marketplaceStatsCountUsersOfServiceProvidersList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
service_provider_uuid string (uuid) UUID of the service provider
customer_uuid string (uuid) UUID of the customer
customer_name string Name of the customer
customer_organization_group_uuid string UUID of the customer's organization group
customer_organization_group_name string Name of the customer's organization group
count integer Count value

Return count of customer members

Return count of customer members.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-stats/customer_member_count/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_stats import marketplace_stats_customer_member_count_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_stats_customer_member_count_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: marketplace_stats_customer_member_count_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceStatsCustomerMemberCountList } from 'waldur-js-client';

try {
  const response = await marketplaceStatsCustomerMemberCountList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid) UUID of the customer
name string Name of the customer
abbreviation string Abbreviation of the customer
count integer Number of members
has_resources boolean Whether the customer has resources

Return summary statistics for customer members

Return summary statistics for customer members.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-stats/customer_member_summary/ \
  Authorization:"Token YOUR_API_TOKEN"

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_stats import marketplace_stats_customer_member_summary_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_stats_customer_member_summary_retrieve.sync(client=client)

print(response)
  1. API Source: marketplace_stats_customer_member_summary_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceStatsCustomerMemberSummaryRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceStatsCustomerMemberSummaryRetrieve({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

200 -

Field Type Description
total_organizations integer Total number of organizations
total_members integer Total number of members across all organizations
organizations_with_resources integer Number of organizations with active resources
average_members_per_org integer Average number of members per organization

Return summary statistics for offering costs

Return summary statistics for offering costs.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-stats/offering_costs_summary/ \
  Authorization:"Token YOUR_API_TOKEN"

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_stats import marketplace_stats_offering_costs_summary_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_stats_offering_costs_summary_retrieve.sync(client=client)

print(response)
  1. API Source: marketplace_stats_offering_costs_summary_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceStatsOfferingCostsSummaryRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceStatsOfferingCostsSummaryRetrieve({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

200 -

Field Type Description
total_cost string (decimal) Total cost of all active resources across all offerings
offering_count integer Number of offerings with active resources
average_cost string (decimal) Average cost per offering

Offerings counter stats

Retrieve statistics about the number of offerings, grouped by category and service provider.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-stats/offerings_counter_stats/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_stats import marketplace_stats_offerings_counter_stats_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_stats_offerings_counter_stats_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: marketplace_stats_offerings_counter_stats_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceStatsOfferingsCounterStatsList } from 'waldur-js-client';

try {
  const response = await marketplaceStatsOfferingsCounterStatsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
category_uuid string (uuid) UUID of the category
category_title string Title of the category
service_provider_name string Name of the service provider
service_provider_uuid string (uuid) UUID of the service provider
count integer Number of offerings

Order stats

Return comprehensive order statistics including daily breakdown, state/type aggregations, and summary stats.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-stats/order_stats/ \
  Authorization:"Token YOUR_API_TOKEN"

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_stats import marketplace_stats_order_stats_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_stats_order_stats_retrieve.sync(client=client)

print(response)
  1. API Source: marketplace_stats_order_stats_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceStatsOrderStatsRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceStatsOrderStatsRetrieve({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
customer_uuid string Filter by customer UUID.
end string End date in YYYY-MM-DD format. Defaults to today.
provider_uuid string Filter by service provider UUID.
start string Start date in YYYY-MM-DD format. Defaults to 30 days ago.

200 -

Field Type Description
summary any Summary statistics
by_state object (free-form) Total order counts grouped by state
by_type object (free-form) Total order counts grouped by type
daily array of objects Daily breakdown
daily.date string (date) Date of the statistics
daily.total integer Total number of orders
daily.total_cost string (decimal) Total cost of orders
daily.revenue string (decimal) Revenue from create/update orders
daily.by_state object (free-form) Order counts grouped by state
daily.by_type object (free-form) Order counts grouped by type

Return project count per organization

Return project count per organization.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-stats/organization_project_count/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_stats import marketplace_stats_organization_project_count_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_stats_organization_project_count_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: marketplace_stats_organization_project_count_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceStatsOrganizationProjectCountList } from 'waldur-js-client';

try {
  const response = await marketplaceStatsOrganizationProjectCountList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
name string Name from the record
uuid string UUID from the record
count integer Count value from the record
abbreviation string Customer abbreviation from the record

Return resource count per organization

Return resource count per organization.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-stats/organization_resource_count/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_stats import marketplace_stats_organization_resource_count_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_stats_organization_resource_count_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: marketplace_stats_organization_resource_count_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceStatsOrganizationResourceCountList } from 'waldur-js-client';

try {
  const response = await marketplaceStatsOrganizationResourceCountList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
name string Name from the record
uuid string UUID from the record
count integer Count value from the record
abbreviation string Customer abbreviation from the record

Return summary statistics for project classification

Return summary statistics for project classification.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-stats/project_classification_summary/ \
  Authorization:"Token YOUR_API_TOKEN"

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_stats import marketplace_stats_project_classification_summary_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_stats_project_classification_summary_retrieve.sync(client=client)

print(response)
  1. API Source: marketplace_stats_project_classification_summary_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceStatsProjectClassificationSummaryRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceStatsProjectClassificationSummaryRetrieve({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

200 -

Field Type Description
total_projects integer Total number of projects
academic_projects integer Number of academic projects (industry_flag=False)
industry_projects integer Number of industry projects (industry_flag=True)

Group project limits by industry flag

Group project limits by industry flag.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-stats/projects_limits_grouped_by_industry_flag/ \
  Authorization:"Token YOUR_API_TOKEN"

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_stats import marketplace_stats_projects_limits_grouped_by_industry_flag_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_stats_projects_limits_grouped_by_industry_flag_retrieve.sync(client=client)

print(response)
  1. API Source: marketplace_stats_projects_limits_grouped_by_industry_flag_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceStatsProjectsLimitsGroupedByIndustryFlagRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceStatsProjectsLimitsGroupedByIndustryFlagRetrieve({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

200 -

Field Type Description
limits object (free-form) Nested dictionary of resource limits by category and component type

Group project limits by OECD code

Group project limits by OECD code.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-stats/projects_limits_grouped_by_oecd/ \
  Authorization:"Token YOUR_API_TOKEN"

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_stats import marketplace_stats_projects_limits_grouped_by_oecd_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_stats_projects_limits_grouped_by_oecd_retrieve.sync(client=client)

print(response)
  1. API Source: marketplace_stats_projects_limits_grouped_by_oecd_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceStatsProjectsLimitsGroupedByOecdRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceStatsProjectsLimitsGroupedByOecdRetrieve({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

200 -

Field Type Description
limits object (free-form) Nested dictionary of resource limits by category and component type

Group project usages by industry flag

Group project usages by industry flag.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-stats/projects_usages_grouped_by_industry_flag/ \
  Authorization:"Token YOUR_API_TOKEN"

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_stats import marketplace_stats_projects_usages_grouped_by_industry_flag_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_stats_projects_usages_grouped_by_industry_flag_retrieve.sync(client=client)

print(response)
  1. API Source: marketplace_stats_projects_usages_grouped_by_industry_flag_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceStatsProjectsUsagesGroupedByIndustryFlagRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceStatsProjectsUsagesGroupedByIndustryFlagRetrieve({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

200 -

Field Type Description
usages object (free-form) Nested dictionary of usage values by category and component type

Group project usages by OECD code

Group project usages by OECD code.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-stats/projects_usages_grouped_by_oecd/ \
  Authorization:"Token YOUR_API_TOKEN"

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_stats import marketplace_stats_projects_usages_grouped_by_oecd_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_stats_projects_usages_grouped_by_oecd_retrieve.sync(client=client)

print(response)
  1. API Source: marketplace_stats_projects_usages_grouped_by_oecd_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceStatsProjectsUsagesGroupedByOecdRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceStatsProjectsUsagesGroupedByOecdRetrieve({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

200 -

Field Type Description
usages object (free-form) Nested dictionary of usage values by category and component type

Return customer statistics for a service provider

Return customer statistics for a service provider.

1
2
3
4
5
http \
  GET \
  https://api.example.com/api/marketplace-stats/provider_customers/ \
  Authorization:"Token YOUR_API_TOKEN" \
  provider_uuid=="a1b2c3d4-e5f6-7890-abcd-ef1234567890"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_stats import marketplace_stats_provider_customers_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_stats_provider_customers_retrieve.sync(
    client=client,
    provider_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
)

print(response)
  1. API Source: marketplace_stats_provider_customers_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceStatsProviderCustomersRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceStatsProviderCustomersRetrieve({
  auth: "Token YOUR_API_TOKEN",
  query: {
    "provider_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
provider_uuid string ✓ Service provider UUID.

200 -

Field Type Description
total integer Total number of customers
new_this_month integer New customers this month
top_by_revenue array of objects Top customers by revenue
top_by_resources array of objects Top customers by resource count
monthly array of objects Monthly customer counts

Return offering performance statistics for a service provider

Return offering performance statistics for a service provider.

1
2
3
4
5
http \
  GET \
  https://api.example.com/api/marketplace-stats/provider_offerings/ \
  Authorization:"Token YOUR_API_TOKEN" \
  provider_uuid=="a1b2c3d4-e5f6-7890-abcd-ef1234567890"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_stats import marketplace_stats_provider_offerings_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_stats_provider_offerings_retrieve.sync(
    client=client,
    provider_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
)

print(response)
  1. API Source: marketplace_stats_provider_offerings_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceStatsProviderOfferingsRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceStatsProviderOfferingsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  query: {
    "provider_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
provider_uuid string ✓ Service provider UUID.

200 -

Field Type Description
offerings array of objects Offering statistics including resources, revenue, and utilization

Return resource statistics for a service provider

Return resource statistics for a service provider.

1
2
3
4
5
http \
  GET \
  https://api.example.com/api/marketplace-stats/provider_resources/ \
  Authorization:"Token YOUR_API_TOKEN" \
  provider_uuid=="a1b2c3d4-e5f6-7890-abcd-ef1234567890"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_stats import marketplace_stats_provider_resources_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_stats_provider_resources_retrieve.sync(
    client=client,
    provider_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
)

print(response)
  1. API Source: marketplace_stats_provider_resources_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceStatsProviderResourcesRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceStatsProviderResourcesRetrieve({
  auth: "Token YOUR_API_TOKEN",
  query: {
    "provider_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
provider_uuid string ✓ Service provider UUID.

200 -

Field Type Description
total integer Total number of resources
by_state object (free-form) Resource counts grouped by state
by_offering array of objects Resource counts grouped by offering
monthly array of objects Monthly resource counts

Get resource provisioning statistics

Get resource provisioning statistics.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-stats/resource_provisioning_stats/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_stats import marketplace_stats_resource_provisioning_stats_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_stats_resource_provisioning_stats_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: marketplace_stats_resource_provisioning_stats_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceStatsResourceProvisioningStatsList } from 'waldur-js-client';

try {
  const response = await marketplaceStatsResourceProvisioningStatsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
last_minutes integer Filter by last N minutes. Default is 60.
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
offering_uuid string (uuid) UUID of the offering
offering_name string Name of the offering
service_provider_uuid string (uuid) UUID of the service provider
service_provider_name string Name of the service provider
provisioning_count integer Total finished provisioning attempts (DONE + ERRED)
provisioning_success_count integer Total successful provisioning attempts (DONE)
provisioning_error_count integer Total failed provisioning attempts (ERRED)
provisioning_in_progress_count integer Total currently in-progress provisioning attempts
provisioning_success_rate number (double) Rate of successful provisioning (0.0 to 1.0)
avg_provisioning_duration number (double) Average duration in seconds from Executing to Terminal state
avg_pending_duration number (double) Average duration in seconds from Creation to Executing state

Return resource usage grouped by creator's affiliation

Return resource usage grouped by creator's affiliation.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-stats/resource_usage_by_creator_affiliation/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_stats import marketplace_stats_resource_usage_by_creator_affiliation_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_stats_resource_usage_by_creator_affiliation_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: marketplace_stats_resource_usage_by_creator_affiliation_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceStatsResourceUsageByCreatorAffiliationList } from 'waldur-js-client';

try {
  const response = await marketplaceStatsResourceUsageByCreatorAffiliationList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
affiliation string User affiliation value
component_type string Component type
total_usage string (decimal) Total usage
total_cost string (decimal) Total cost
resource_count integer Number of resources

Return resource usage statistics grouped by customer

Return resource usage statistics grouped by customer.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-stats/resource_usage_by_customer/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_stats import marketplace_stats_resource_usage_by_customer_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_stats_resource_usage_by_customer_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: marketplace_stats_resource_usage_by_customer_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceStatsResourceUsageByCustomerList } from 'waldur-js-client';

try {
  const response = await marketplaceStatsResourceUsageByCustomerList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
customer_uuid string (uuid) UUID of the customer
customer_name string Name of the customer
customer_abbreviation string Abbreviation of the customer
resources_ok integer Number of OK resources
resources_erred integer Number of erred resources
resources_total integer Total number of active resources
total_cost string (decimal) Total cost of resources
usages object (free-form) Component usages keyed by component type
limits object (free-form) Resource limits keyed by limit name

Return component usages grouped by project members' organization type

Return component usages grouped by project members' organization type.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-stats/resource_usage_by_organization_type/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_stats import marketplace_stats_resource_usage_by_organization_type_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_stats_resource_usage_by_organization_type_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: marketplace_stats_resource_usage_by_organization_type_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceStatsResourceUsageByOrganizationTypeList } from 'waldur-js-client';

try {
  const response = await marketplaceStatsResourceUsageByOrganizationTypeList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
organization_type string SCHAC organization type URN
component_type string Component type (e.g., cpu, gpu)
usage string (decimal) Total usage for this component
resource_count integer Number of resources

Return summary statistics for resource geographic distribution

Return summary statistics for resource geographic distribution.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-stats/resources_geography_summary/ \
  Authorization:"Token YOUR_API_TOKEN"

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_stats import marketplace_stats_resources_geography_summary_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_stats_resources_geography_summary_retrieve.sync(client=client)

print(response)
  1. API Source: marketplace_stats_resources_geography_summary_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceStatsResourcesGeographySummaryRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceStatsResourcesGeographySummaryRetrieve({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

200 -

Field Type Description
total_resources integer Total number of active resources
countries_count integer Number of countries with active resources
org_groups_count integer Number of organization groups with active resources
offerings_count integer Number of offerings with active resources

Return resources limits per offering

Return resources limits per offering.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-stats/resources_limits/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_stats import marketplace_stats_resources_limits_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_stats_resources_limits_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: marketplace_stats_resources_limits_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceStatsResourcesLimitsList } from 'waldur-js-client';

try {
  const response = await marketplaceStatsResourcesLimitsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
offering_uuid string (uuid) UUID of the offering
name string Name of the limit
value integer Limit value
offering_country string Country of the offering
organization_group_name string Name of the organization group
organization_group_uuid string UUID of the organization group

Resources missing usage

Return usage-based resources with no usage reported in the specified billing period.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-stats/resources_missing_usage/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_stats import marketplace_stats_resources_missing_usage_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_stats_resources_missing_usage_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: marketplace_stats_resources_missing_usage_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceStatsResourcesMissingUsageList } from 'waldur-js-client';

try {
  const response = await marketplaceStatsResourcesMissingUsageList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
billing_period string Billing period in YYYY-MM format. Defaults to current month.
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
provider_uuid string Filter by service provider UUID.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid) UUID of the resource
name string Name of the resource
state string Current state of the resource
created string (date-time) Creation date of the resource
offering_name string Name of the offering
offering_uuid string (uuid) UUID of the offering
provider_name string Name of the service provider
provider_uuid string (uuid) UUID of the service provider
customer_name string Name of the customer organization
customer_uuid string (uuid) UUID of the customer organization
project_name string Name of the project
project_uuid string (uuid) UUID of the project
last_usage_date string (date-time) Date of the last usage report
days_since_last_report integer Number of days since last usage report

Total cost of active resources per offering

Total cost of active resources per offering.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-stats/total_cost_of_active_resources_per_offering/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_stats import marketplace_stats_total_cost_of_active_resources_per_offering_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_stats_total_cost_of_active_resources_per_offering_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: marketplace_stats_total_cost_of_active_resources_per_offering_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceStatsTotalCostOfActiveResourcesPerOfferingList } from 'waldur-js-client';

try {
  const response = await marketplaceStatsTotalCostOfActiveResourcesPerOfferingList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
offering_uuid string (uuid) UUID of the offering
offering_name string Name of the offering
cost number (double) Total cost for the offering

Return user count grouped by affiliation

Return user count grouped by affiliation.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-stats/user_affiliation_count/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_stats import marketplace_stats_user_affiliation_count_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_stats_user_affiliation_count_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: marketplace_stats_user_affiliation_count_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceStatsUserAffiliationCountList } from 'waldur-js-client';

try {
  const response = await marketplaceStatsUserAffiliationCountList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
affiliation string Affiliation name
count integer Number of users

Return user count grouped by authentication method

Return user count grouped by authentication method.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-stats/user_auth_method_count/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_stats import marketplace_stats_user_auth_method_count_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_stats_user_auth_method_count_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: marketplace_stats_user_auth_method_count_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceStatsUserAuthMethodCountList } from 'waldur-js-client';

try {
  const response = await marketplaceStatsUserAuthMethodCountList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
method string Authentication method
count integer Number of users

Return user count grouped by identity source

Return user count grouped by identity source.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-stats/user_identity_source_count/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_stats import marketplace_stats_user_identity_source_count_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_stats_user_identity_source_count_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: marketplace_stats_user_identity_source_count_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceStatsUserIdentitySourceCountList } from 'waldur-js-client';

try {
  const response = await marketplaceStatsUserIdentitySourceCountList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
identity_source string Identity source
count integer Number of users

Return user count grouped by job title

Return user count grouped by job title.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-stats/user_job_title_count/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_stats import marketplace_stats_user_job_title_count_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_stats_user_job_title_count_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: marketplace_stats_user_job_title_count_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceStatsUserJobTitleCountList } from 'waldur-js-client';

try {
  const response = await marketplaceStatsUserJobTitleCountList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
job_title string Job title
count integer Number of users

Return user count grouped by organization

Return user count grouped by organization.

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-stats/user_organization_count/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_stats import marketplace_stats_user_organization_count_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_stats_user_organization_count_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: marketplace_stats_user_organization_count_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceStatsUserOrganizationCountList } from 'waldur-js-client';

try {
  const response = await marketplaceStatsUserOrganizationCountList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
organization string Organization name
count integer Number of users

Return user count grouped by organization type (SCHAC URN)

Return user count grouped by organization type (SCHAC URN).

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-stats/user_organization_type_count/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_stats import marketplace_stats_user_organization_type_count_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_stats_user_organization_type_count_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: marketplace_stats_user_organization_type_count_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceStatsUserOrganizationTypeCountList } from 'waldur-js-client';

try {
  const response = await marketplaceStatsUserOrganizationTypeCountList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
organization_type string Organization type (SCHAC URN)
count integer Number of users

Proposals and calls

Calls for proposals

Call Assignment Configurations

Operations Summary

Method Endpoint Description
GET /api/call-assignment-configurations/ List Call Assignment Configurations
GET /api/call-assignment-configurations/{uuid}/ Retrieve
POST /api/call-assignment-configurations/ Create
PUT /api/call-assignment-configurations/{uuid}/ Update
PATCH /api/call-assignment-configurations/{uuid}/ Partial Update
DELETE /api/call-assignment-configurations/{uuid}/ Delete

List Call Assignment Configurations

1
2
3
4
http \
  GET \
  https://api.example.com/api/call-assignment-configurations/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.call_assignment_configurations import call_assignment_configurations_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = call_assignment_configurations_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: call_assignment_configurations_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { callAssignmentConfigurationsList } from 'waldur-js-client';

try {
  const response = await callAssignmentConfigurationsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid)
call string (uri)
call_uuid string (uuid)
call_name string
auto_reassign_on_decline boolean Automatically assign next-best reviewer when someone declines. If False, manager must manually approve reassignments.
max_auto_reassign_attempts integer Maximum automatic reassignment attempts before requiring manual intervention.
assignment_expiration_days integer Days until assignment invitation expires if not responded to.
send_reminder_before_expiry_days integer Days before expiry to send reminder notification.
created string (date-time)
modified string (date-time)

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/call-assignment-configurations/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.call_assignment_configurations import call_assignment_configurations_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = call_assignment_configurations_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: call_assignment_configurations_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { callAssignmentConfigurationsRetrieve } from 'waldur-js-client';

try {
  const response = await callAssignmentConfigurationsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
uuid string (uuid)
call string (uri)
call_uuid string (uuid)
call_name string
auto_reassign_on_decline boolean Automatically assign next-best reviewer when someone declines. If False, manager must manually approve reassignments.
max_auto_reassign_attempts integer Maximum automatic reassignment attempts before requiring manual intervention.
assignment_expiration_days integer Days until assignment invitation expires if not responded to.
send_reminder_before_expiry_days integer Days before expiry to send reminder notification.
created string (date-time)
modified string (date-time)

Create

1
2
3
4
http \
  POST \
  https://api.example.com/api/call-assignment-configurations/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.call_assignment_configuration_request import CallAssignmentConfigurationRequest # (1)
from waldur_api_client.api.call_assignment_configurations import call_assignment_configurations_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = CallAssignmentConfigurationRequest()
response = call_assignment_configurations_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: CallAssignmentConfigurationRequest
  2. API Source: call_assignment_configurations_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { callAssignmentConfigurationsCreate } from 'waldur-js-client';

try {
  const response = await callAssignmentConfigurationsCreate({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
auto_reassign_on_decline boolean Automatically assign next-best reviewer when someone declines. If False, manager must manually approve reassignments.
max_auto_reassign_attempts integer Maximum automatic reassignment attempts before requiring manual intervention.
assignment_expiration_days integer Days until assignment invitation expires if not responded to.
send_reminder_before_expiry_days integer Days before expiry to send reminder notification.

201 -

Field Type Description
uuid string (uuid)
call string (uri)
call_uuid string (uuid)
call_name string
auto_reassign_on_decline boolean Automatically assign next-best reviewer when someone declines. If False, manager must manually approve reassignments.
max_auto_reassign_attempts integer Maximum automatic reassignment attempts before requiring manual intervention.
assignment_expiration_days integer Days until assignment invitation expires if not responded to.
send_reminder_before_expiry_days integer Days before expiry to send reminder notification.
created string (date-time)
modified string (date-time)

Update

1
2
3
4
http \
  PUT \
  https://api.example.com/api/call-assignment-configurations/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.call_assignment_configuration_request import CallAssignmentConfigurationRequest # (1)
from waldur_api_client.api.call_assignment_configurations import call_assignment_configurations_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = CallAssignmentConfigurationRequest()
response = call_assignment_configurations_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: CallAssignmentConfigurationRequest
  2. API Source: call_assignment_configurations_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { callAssignmentConfigurationsUpdate } from 'waldur-js-client';

try {
  const response = await callAssignmentConfigurationsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
auto_reassign_on_decline boolean Automatically assign next-best reviewer when someone declines. If False, manager must manually approve reassignments.
max_auto_reassign_attempts integer Maximum automatic reassignment attempts before requiring manual intervention.
assignment_expiration_days integer Days until assignment invitation expires if not responded to.
send_reminder_before_expiry_days integer Days before expiry to send reminder notification.

200 -

Field Type Description
uuid string (uuid)
call string (uri)
call_uuid string (uuid)
call_name string
auto_reassign_on_decline boolean Automatically assign next-best reviewer when someone declines. If False, manager must manually approve reassignments.
max_auto_reassign_attempts integer Maximum automatic reassignment attempts before requiring manual intervention.
assignment_expiration_days integer Days until assignment invitation expires if not responded to.
send_reminder_before_expiry_days integer Days before expiry to send reminder notification.
created string (date-time)
modified string (date-time)

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/call-assignment-configurations/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_call_assignment_configuration_request import PatchedCallAssignmentConfigurationRequest # (1)
from waldur_api_client.api.call_assignment_configurations import call_assignment_configurations_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedCallAssignmentConfigurationRequest()
response = call_assignment_configurations_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedCallAssignmentConfigurationRequest
  2. API Source: call_assignment_configurations_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { callAssignmentConfigurationsPartialUpdate } from 'waldur-js-client';

try {
  const response = await callAssignmentConfigurationsPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
auto_reassign_on_decline boolean Automatically assign next-best reviewer when someone declines. If False, manager must manually approve reassignments.
max_auto_reassign_attempts integer Maximum automatic reassignment attempts before requiring manual intervention.
assignment_expiration_days integer Days until assignment invitation expires if not responded to.
send_reminder_before_expiry_days integer Days before expiry to send reminder notification.

200 -

Field Type Description
uuid string (uuid)
call string (uri)
call_uuid string (uuid)
call_name string
auto_reassign_on_decline boolean Automatically assign next-best reviewer when someone declines. If False, manager must manually approve reassignments.
max_auto_reassign_attempts integer Maximum automatic reassignment attempts before requiring manual intervention.
assignment_expiration_days integer Days until assignment invitation expires if not responded to.
send_reminder_before_expiry_days integer Days before expiry to send reminder notification.
created string (date-time)
modified string (date-time)

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/call-assignment-configurations/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.call_assignment_configurations import call_assignment_configurations_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = call_assignment_configurations_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: call_assignment_configurations_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { callAssignmentConfigurationsDestroy } from 'waldur-js-client';

try {
  const response = await callAssignmentConfigurationsDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Call Managing Organisations

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/call-managing-organisations/ List Call Managing Organisations
GET /api/call-managing-organisations/{uuid}/ Retrieve
POST /api/call-managing-organisations/ Create
PUT /api/call-managing-organisations/{uuid}/ Update
PATCH /api/call-managing-organisations/{uuid}/ Partial Update
DELETE /api/call-managing-organisations/{uuid}/ Delete
Permissions & Users
GET /api/call-managing-organisations/{uuid}/list_users/ List users and their roles in a scope
POST /api/call-managing-organisations/{uuid}/add_user/ Grant a role to a user
POST /api/call-managing-organisations/{uuid}/delete_user/ Revoke a role from a user
POST /api/call-managing-organisations/{uuid}/update_user/ Update a user's role expiration
Other Actions
GET /api/call-managing-organisations/{uuid}/stats/ Return statistics for call managing organisation

Core CRUD

List Call Managing Organisations

1
2
3
4
http \
  GET \
  https://api.example.com/api/call-managing-organisations/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.call_managing_organisation_o_enum import CallManagingOrganisationOEnum # (1)
from waldur_api_client.api.call_managing_organisations import call_managing_organisations_list # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = call_managing_organisations_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: CallManagingOrganisationOEnum
  2. API Source: call_managing_organisations_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { callManagingOrganisationsList } from 'waldur-js-client';

try {
  const response = await callManagingOrganisationsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
customer string (uri)
customer_keyword string
customer_uuid string (uuid)
o array Ordering
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
url string (uri)
uuid string (uuid)
created string (date-time)
description string
customer string (uri)
customer_name string
customer_uuid string (uuid)
customer_image string (uri)
customer_abbreviation string
customer_native_name string
customer_country string
image string (uri)

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/call-managing-organisations/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.call_managing_organisations import call_managing_organisations_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = call_managing_organisations_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: call_managing_organisations_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { callManagingOrganisationsRetrieve } from 'waldur-js-client';

try {
  const response = await callManagingOrganisationsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
url string (uri)
uuid string (uuid)
created string (date-time)
description string
customer string (uri)
customer_name string
customer_uuid string (uuid)
customer_image string (uri)
customer_abbreviation string
customer_native_name string
customer_country string
image string (uri)

Create

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/call-managing-organisations/ \
  Authorization:"Token YOUR_API_TOKEN" \
  customer="https://api.example.com/api/customer/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.call_managing_organisation_request import CallManagingOrganisationRequest # (1)
from waldur_api_client.api.call_managing_organisations import call_managing_organisations_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = CallManagingOrganisationRequest(
    customer="https://api.example.com/api/customer/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = call_managing_organisations_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: CallManagingOrganisationRequest
  2. API Source: call_managing_organisations_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { callManagingOrganisationsCreate } from 'waldur-js-client';

try {
  const response = await callManagingOrganisationsCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "customer": "https://api.example.com/api/customer/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required
description string
customer string (uri) ✓
image string (binary)

201 -

Field Type
url string (uri)
uuid string (uuid)
created string (date-time)
description string
customer string (uri)
customer_name string
customer_uuid string (uuid)
customer_image string (uri)
customer_abbreviation string
customer_native_name string
customer_country string
image string (uri)

Update

1
2
3
4
5
http \
  PUT \
  https://api.example.com/api/call-managing-organisations/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  customer="https://api.example.com/api/customer/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.call_managing_organisation_request import CallManagingOrganisationRequest # (1)
from waldur_api_client.api.call_managing_organisations import call_managing_organisations_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = CallManagingOrganisationRequest(
    customer="https://api.example.com/api/customer/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = call_managing_organisations_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: CallManagingOrganisationRequest
  2. API Source: call_managing_organisations_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { callManagingOrganisationsUpdate } from 'waldur-js-client';

try {
  const response = await callManagingOrganisationsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "customer": "https://api.example.com/api/customer/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
description string
customer string (uri) ✓
image string (binary)

200 -

Field Type
url string (uri)
uuid string (uuid)
created string (date-time)
description string
customer string (uri)
customer_name string
customer_uuid string (uuid)
customer_image string (uri)
customer_abbreviation string
customer_native_name string
customer_country string
image string (uri)

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/call-managing-organisations/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_call_managing_organisation_request import PatchedCallManagingOrganisationRequest # (1)
from waldur_api_client.api.call_managing_organisations import call_managing_organisations_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedCallManagingOrganisationRequest()
response = call_managing_organisations_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedCallManagingOrganisationRequest
  2. API Source: call_managing_organisations_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { callManagingOrganisationsPartialUpdate } from 'waldur-js-client';

try {
  const response = await callManagingOrganisationsPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
description string
image string (binary)

200 -

Field Type
url string (uri)
uuid string (uuid)
created string (date-time)
description string
customer string (uri)
customer_name string
customer_uuid string (uuid)
customer_image string (uri)
customer_abbreviation string
customer_native_name string
customer_country string
image string (uri)

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/call-managing-organisations/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.call_managing_organisations import call_managing_organisations_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = call_managing_organisations_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: call_managing_organisations_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { callManagingOrganisationsDestroy } from 'waldur-js-client';

try {
  const response = await callManagingOrganisationsDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Permissions & Users

List users and their roles in a scope

Retrieves a list of users who have a role within a specific scope (e.g., a project or an organization). The list can be filtered by user details or role.

1
2
3
4
http \
  GET \
  https://api.example.com/api/call-managing-organisations/a1b2c3d4-e5f6-7890-abcd-ef1234567890/list_users/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.user_role_details_field_enum import UserRoleDetailsFieldEnum # (1)
from waldur_api_client.models.user_role_details_o_enum import UserRoleDetailsOEnum # (2)
from waldur_api_client.api.call_managing_organisations import call_managing_organisations_list_users_list # (3)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = call_managing_organisations_list_users_list.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

for item in response:
    print(item)
  1. Model Source: UserRoleDetailsFieldEnum
  2. Model Source: UserRoleDetailsOEnum
  3. API Source: call_managing_organisations_list_users_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { callManagingOrganisationsListUsersList } from 'waldur-js-client';

try {
  const response = await callManagingOrganisationsListUsersList({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type Description
field array Fields to include in response
full_name string User full name
native_name string User native name
o array Ordering fields
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
role string (uuid) Role UUID or name
search_string string Search string for user
user string (uuid) User UUID
user_slug string User slug
user_url string User URL
username string User username

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid)
created string (date-time)
expiration_time string (date-time)
role_name string
role_uuid string (uuid)
user_email string (email)
user_full_name string
user_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
user_uuid string (uuid)
user_image string (uri)
created_by_full_name string
created_by_uuid string (uuid)

Grant a role to a user

Assigns a specific role to a user within the current scope. An optional expiration time for the role can be set.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/call-managing-organisations/a1b2c3d4-e5f6-7890-abcd-ef1234567890/add_user/ \
  Authorization:"Token YOUR_API_TOKEN" \
  role="string-value" \
  user="a1b2c3d4-e5f6-7890-abcd-ef1234567890"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.user_role_create_request import UserRoleCreateRequest # (1)
from waldur_api_client.api.call_managing_organisations import call_managing_organisations_add_user # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = UserRoleCreateRequest(
    role="string-value",
    user="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
)
response = call_managing_organisations_add_user.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: UserRoleCreateRequest
  2. API Source: call_managing_organisations_add_user
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { callManagingOrganisationsAddUser } from 'waldur-js-client';

try {
  const response = await callManagingOrganisationsAddUser({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "role": "string-value",
    "user": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
role string ✓
user string (uuid) ✓
expiration_time string (date-time)

201 -

Field Type
expiration_time string (date-time)

400 - Validation error, for example when trying to add a user to a terminated project.

Revoke a role from a user

Removes a specific role from a user within the current scope. This effectively revokes their permissions associated with that role.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/call-managing-organisations/a1b2c3d4-e5f6-7890-abcd-ef1234567890/delete_user/ \
  Authorization:"Token YOUR_API_TOKEN" \
  role="string-value" \
  user="a1b2c3d4-e5f6-7890-abcd-ef1234567890"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.user_role_delete_request import UserRoleDeleteRequest # (1)
from waldur_api_client.api.call_managing_organisations import call_managing_organisations_delete_user # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = UserRoleDeleteRequest(
    role="string-value",
    user="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
)
response = call_managing_organisations_delete_user.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: UserRoleDeleteRequest
  2. API Source: call_managing_organisations_delete_user
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { callManagingOrganisationsDeleteUser } from 'waldur-js-client';

try {
  const response = await callManagingOrganisationsDeleteUser({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "role": "string-value",
    "user": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
role string ✓
user string (uuid) ✓
expiration_time string (date-time)

200 - Role revoked successfully.

Update a user's role expiration

Updates the expiration time for a user's existing role in the current scope. This is useful for extending or shortening the duration of a permission. To make a role permanent, set expiration_time to null.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/call-managing-organisations/a1b2c3d4-e5f6-7890-abcd-ef1234567890/update_user/ \
  Authorization:"Token YOUR_API_TOKEN" \
  role="string-value" \
  user="a1b2c3d4-e5f6-7890-abcd-ef1234567890"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.user_role_update_request import UserRoleUpdateRequest # (1)
from waldur_api_client.api.call_managing_organisations import call_managing_organisations_update_user # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = UserRoleUpdateRequest(
    role="string-value",
    user="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
)
response = call_managing_organisations_update_user.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: UserRoleUpdateRequest
  2. API Source: call_managing_organisations_update_user
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { callManagingOrganisationsUpdateUser } from 'waldur-js-client';

try {
  const response = await callManagingOrganisationsUpdateUser({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "role": "string-value",
    "user": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
role string ✓
user string (uuid) ✓
expiration_time string (date-time)

200 -

Field Type
expiration_time string (date-time)

Other Actions

Return statistics for call managing organisation

Return statistics for call managing organisation.

1
2
3
4
http \
  GET \
  https://api.example.com/api/call-managing-organisations/a1b2c3d4-e5f6-7890-abcd-ef1234567890/stats/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.call_managing_organisations import call_managing_organisations_stats_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = call_managing_organisations_stats_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: call_managing_organisations_stats_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { callManagingOrganisationsStatsRetrieve } from 'waldur-js-client';

try {
  const response = await callManagingOrganisationsStatsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
open_calls integer
active_rounds integer
accepted_proposals integer
pending_proposals integer
pending_review integer
rounds_closing_in_one_week integer
calls_closing_in_one_week integer
offering_requests_pending integer

Call Proposal Project Role Mappings

Operations Summary

Method Endpoint Description
GET /api/call-proposal-project-role-mappings/ List Call Proposal Project Role Mappings
GET /api/call-proposal-project-role-mappings/{uuid}/ Retrieve
POST /api/call-proposal-project-role-mappings/ Create
PUT /api/call-proposal-project-role-mappings/{uuid}/ Update
PATCH /api/call-proposal-project-role-mappings/{uuid}/ Partial Update
DELETE /api/call-proposal-project-role-mappings/{uuid}/ Delete

List Call Proposal Project Role Mappings

1
2
3
4
http \
  GET \
  https://api.example.com/api/call-proposal-project-role-mappings/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.call_proposal_project_role_mappings import call_proposal_project_role_mappings_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = call_proposal_project_role_mappings_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: call_proposal_project_role_mappings_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { callProposalProjectRoleMappingsList } from 'waldur-js-client';

try {
  const response = await callProposalProjectRoleMappingsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
call_uuid string (uuid)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
url string (uri)
uuid string (uuid)
call string (uri)
call_uuid string (uuid)
call_name string
proposal_role string
project_role string

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/call-proposal-project-role-mappings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.call_proposal_project_role_mappings import call_proposal_project_role_mappings_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = call_proposal_project_role_mappings_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: call_proposal_project_role_mappings_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { callProposalProjectRoleMappingsRetrieve } from 'waldur-js-client';

try {
  const response = await callProposalProjectRoleMappingsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
url string (uri)
uuid string (uuid)
call string (uri)
call_uuid string (uuid)
call_name string
proposal_role string
project_role string

Create

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/call-proposal-project-role-mappings/ \
  Authorization:"Token YOUR_API_TOKEN" \
  call="https://api.example.com/api/call/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  proposal_role="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.proposal_project_role_mapping_request import ProposalProjectRoleMappingRequest # (1)
from waldur_api_client.api.call_proposal_project_role_mappings import call_proposal_project_role_mappings_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ProposalProjectRoleMappingRequest(
    call="https://api.example.com/api/call/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    proposal_role="string-value"
)
response = call_proposal_project_role_mappings_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ProposalProjectRoleMappingRequest
  2. API Source: call_proposal_project_role_mappings_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { callProposalProjectRoleMappingsCreate } from 'waldur-js-client';

try {
  const response = await callProposalProjectRoleMappingsCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "call": "https://api.example.com/api/call/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "proposal_role": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required
call string (uri) ✓
proposal_role string ✓
project_role string

201 -

Field Type
url string (uri)
uuid string (uuid)
call string (uri)
call_uuid string (uuid)
call_name string
proposal_role string
project_role string

Update

1
2
3
4
5
6
http \
  PUT \
  https://api.example.com/api/call-proposal-project-role-mappings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  call="https://api.example.com/api/call/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  proposal_role="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.proposal_project_role_mapping_request import ProposalProjectRoleMappingRequest # (1)
from waldur_api_client.api.call_proposal_project_role_mappings import call_proposal_project_role_mappings_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ProposalProjectRoleMappingRequest(
    call="https://api.example.com/api/call/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    proposal_role="string-value"
)
response = call_proposal_project_role_mappings_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ProposalProjectRoleMappingRequest
  2. API Source: call_proposal_project_role_mappings_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { callProposalProjectRoleMappingsUpdate } from 'waldur-js-client';

try {
  const response = await callProposalProjectRoleMappingsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "call": "https://api.example.com/api/call/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "proposal_role": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
call string (uri) ✓
proposal_role string ✓
project_role string

200 -

Field Type
url string (uri)
uuid string (uuid)
call string (uri)
call_uuid string (uuid)
call_name string
proposal_role string
project_role string

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/call-proposal-project-role-mappings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_proposal_project_role_mapping_request import PatchedProposalProjectRoleMappingRequest # (1)
from waldur_api_client.api.call_proposal_project_role_mappings import call_proposal_project_role_mappings_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedProposalProjectRoleMappingRequest()
response = call_proposal_project_role_mappings_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedProposalProjectRoleMappingRequest
  2. API Source: call_proposal_project_role_mappings_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { callProposalProjectRoleMappingsPartialUpdate } from 'waldur-js-client';

try {
  const response = await callProposalProjectRoleMappingsPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
call string (uri)
proposal_role string
project_role string

200 -

Field Type
url string (uri)
uuid string (uuid)
call string (uri)
call_uuid string (uuid)
call_name string
proposal_role string
project_role string

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/call-proposal-project-role-mappings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.call_proposal_project_role_mappings import call_proposal_project_role_mappings_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = call_proposal_project_role_mappings_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: call_proposal_project_role_mappings_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { callProposalProjectRoleMappingsDestroy } from 'waldur-js-client';

try {
  const response = await callProposalProjectRoleMappingsDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Proposal Protected Calls

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/proposal-protected-calls/ List Proposal Protected Calls
GET /api/proposal-protected-calls/{uuid}/ Retrieve
POST /api/proposal-protected-calls/ Create
POST /api/proposal-protected-calls/{uuid}/create-manual-assignment/ Create manual assignment
POST /api/proposal-protected-calls/{uuid}/update_applicant_attribute_config/ Create or update applicant attribute exposure configuration
PUT /api/proposal-protected-calls/{uuid}/ Update
PATCH /api/proposal-protected-calls/{uuid}/ Partial Update
PATCH /api/proposal-protected-calls/{uuid}/update_applicant_attribute_config/ Create or update applicant attribute exposure configuration
DELETE /api/proposal-protected-calls/{uuid}/ Delete
Permissions & Users
GET /api/proposal-protected-calls/{uuid}/list_users/ List users and their roles in a scope
POST /api/proposal-protected-calls/{uuid}/add_user/ Grant a role to a user
POST /api/proposal-protected-calls/{uuid}/delete_user/ Revoke a role from a user
POST /api/proposal-protected-calls/{uuid}/update_user/ Update a user's role expiration
Other Actions
GET /api/proposal-protected-calls/{uuid}/affinity-matrix/ Get affinity matrix for reviewer-proposal matching
GET /api/proposal-protected-calls/{uuid}/applicant_attribute_config/ Get applicant attribute exposure configuration for this call
GET /api/proposal-protected-calls/available_compliance_checklists/ Get available compliance checklists for call creation/editing
GET /api/proposal-protected-calls/{uuid}/coi-configuration/ Get COI configuration for this call
GET /api/proposal-protected-calls/{uuid}/compliance_overview/ Compliance overview
GET /api/proposal-protected-calls/{uuid}/conflict-summary/ Get summary statistics of conflicts for this call
GET /api/proposal-protected-calls/{uuid}/conflicts/ List all conflicts of interest detected for this call
GET /api/proposal-protected-calls/{uuid}/matching-configuration/ Get or update matching configuration for this call
GET /api/proposal-protected-calls/{uuid}/offerings/ List offerings for a call
GET /api/proposal-protected-calls/{uuid}/offerings/{obj_uuid}/ Retrieve
GET /api/proposal-protected-calls/{uuid}/proposals/{proposal_uuid}/compliance-answers/ Get detailed compliance answers for a specific proposal (call managers only)
GET /api/proposal-protected-calls/{uuid}/proposed-assignments/ Get proposed reviewer-proposal assignments
GET /api/proposal-protected-calls/{uuid}/resource_templates/ List resource templates for a call
GET /api/proposal-protected-calls/{uuid}/resource_templates/{obj_uuid}/ Retrieve
GET /api/proposal-protected-calls/{uuid}/reviewer-pool/ List reviewer pool members for a call
GET /api/proposal-protected-calls/{uuid}/rounds/ List rounds for a call
GET /api/proposal-protected-calls/{uuid}/rounds/{obj_uuid}/ Retrieve
GET /api/proposal-protected-calls/{uuid}/suggestions/ List all reviewer suggestions for this call with affinity scores
POST /api/proposal-protected-calls/{uuid}/activate/ Activate a call
POST /api/proposal-protected-calls/{uuid}/archive/ Archive a call
POST /api/proposal-protected-calls/{uuid}/attach_documents/ Attach documents to call
POST /api/proposal-protected-calls/{uuid}/compute-affinities/ Compute affinity scores for all reviewer-proposal pairs
POST /api/proposal-protected-calls/{uuid}/detach_documents/ Detach documents from call
POST /api/proposal-protected-calls/{uuid}/detect-conflicts/ Trigger automated COI detection for all reviewer-proposal pairs
POST /api/proposal-protected-calls/{uuid}/generate-assignments/ Generate assignments
POST /api/proposal-protected-calls/{uuid}/generate-suggestions/ Generate reviewer suggestions with configurable matching source
POST /api/proposal-protected-calls/{uuid}/invite-by-email/ Invite by email
POST /api/proposal-protected-calls/{uuid}/reviewer-pool/ Invite reviewers to join the call's reviewer pool
POST /api/proposal-protected-calls/{uuid}/offerings/ Create offering for a call
POST /api/proposal-protected-calls/{uuid}/resource_templates/ Create resource template for a call
POST /api/proposal-protected-calls/{uuid}/review_proposal_compliance/ Mark proposal compliance as reviewed by call manager
POST /api/proposal-protected-calls/{uuid}/rounds/{obj_uuid}/close/ Close
POST /api/proposal-protected-calls/{uuid}/rounds/ Create a round for a call
POST /api/proposal-protected-calls/{uuid}/send-all-assignments/ Send all draft assignment batches for this call
POST /api/proposal-protected-calls/{uuid}/send-invitations/ Send invitations to all confirmed suggestions
PUT /api/proposal-protected-calls/{uuid}/offerings/{obj_uuid}/ Update
PUT /api/proposal-protected-calls/{uuid}/resource_templates/{obj_uuid}/ Update
PUT /api/proposal-protected-calls/{uuid}/rounds/{obj_uuid}/ Update
PATCH /api/proposal-protected-calls/{uuid}/coi-configuration/ Get COI configuration for this call
PATCH /api/proposal-protected-calls/{uuid}/matching-configuration/ Get or update matching configuration for this call
PATCH /api/proposal-protected-calls/{uuid}/offerings/{obj_uuid}/ Partial Update
PATCH /api/proposal-protected-calls/{uuid}/resource_templates/{obj_uuid}/ Partial Update
PATCH /api/proposal-protected-calls/{uuid}/rounds/{obj_uuid}/ Partial Update
DELETE /api/proposal-protected-calls/{uuid}/delete_applicant_attribute_config/ Delete custom applicant attribute config, reverting to system defaults
DELETE /api/proposal-protected-calls/{uuid}/offerings/{obj_uuid}/ Delete
DELETE /api/proposal-protected-calls/{uuid}/resource_templates/{obj_uuid}/ Delete
DELETE /api/proposal-protected-calls/{uuid}/rounds/{obj_uuid}/ Delete

Core CRUD

List Proposal Protected Calls

1
2
3
4
http \
  GET \
  https://api.example.com/api/proposal-protected-calls/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.call_states import CallStates # (1)
from waldur_api_client.models.protected_call_field_enum import ProtectedCallFieldEnum # (2)
from waldur_api_client.models.protected_call_o_enum import ProtectedCallOEnum # (3)
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_list # (4)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = proposal_protected_calls_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: CallStates
  2. Model Source: ProtectedCallFieldEnum
  3. Model Source: ProtectedCallOEnum
  4. API Source: proposal_protected_calls_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { proposalProtectedCallsList } from 'waldur-js-client';

try {
  const response = await proposalProtectedCallsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
customer string (uri)
customer_keyword string
customer_uuid string (uuid)
field array
has_active_round boolean
name string
o array Ordering
offering_uuid string (uuid)
offerings_provider_uuid string (uuid)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
state array

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
created string (date-time)
start_date string (date-time)
end_date string (date-time)
slug string URL-friendly identifier. Only editable by staff users.
name string
description string
state any
manager string (uri)
manager_uuid string (uuid)
customer_name string
customer_uuid string (uuid)
offerings array of objects
offerings.uuid string (uuid)
offerings.state any
offerings.offering string (uri)
offerings.offering_name string
offerings.offering_uuid string (uuid)
offerings.provider_name string
offerings.category_uuid string (uuid)
offerings.category_name string
offerings.call_managing_organisation string
offerings.attributes any
offerings.plan string (uri)
offerings.plan_details any
offerings.options any
offerings.components array of objects
offerings.components.uuid string (uuid)
offerings.components.billing_type string
Enum: fixed, usage, limit, one, few
offerings.components.type string Unique internal name of the measured unit, for example floating_ip.
offerings.components.name string Display name for the measured unit, for example, Floating IP.
offerings.components.description string
offerings.components.measured_unit string Unit of measurement, for example, GB.
offerings.components.unit_factor integer The conversion factor from backend units to measured_unit
offerings.components.limit_period any
offerings.components.limit_amount integer
offerings.components.article_code string
offerings.components.max_value integer
offerings.components.min_value integer
offerings.components.max_available_limit integer
offerings.components.is_boolean boolean
offerings.components.default_limit integer
offerings.components.factor integer
offerings.components.is_builtin boolean
offerings.components.is_prepaid boolean
offerings.components.overage_component string (uuid)
offerings.components.min_prepaid_duration integer
offerings.components.max_prepaid_duration integer
offerings.created string (date-time)
rounds array of objects
rounds.uuid string (uuid)
rounds.slug string
rounds.name string
rounds.start_time string (date-time)
rounds.cutoff_time string (date-time)
rounds.status any
rounds.review_strategy string
Enum: after_round, after_proposal
rounds.deciding_entity string
Enum: by_call_manager, automatic
rounds.allocation_time string
Enum: on_decision, fixed_date
rounds.allocation_date string (date-time)
rounds.minimal_average_scoring string (decimal)
rounds.review_duration_in_days integer
rounds.minimum_number_of_reviewers integer
documents array of objects
documents.uuid string (uuid)
documents.file string (uri) Documentation for call for proposals.
documents.file_name string
documents.file_size integer
documents.description string
documents.created string (date-time)
resource_templates array of objects
resource_templates.uuid string (uuid)
resource_templates.url string
resource_templates.name string
resource_templates.description string
resource_templates.attributes any
resource_templates.limits any
resource_templates.is_required boolean If True, every proposal must include this resource type
resource_templates.requested_offering string (uri)
resource_templates.requested_offering_name string
resource_templates.requested_offering_uuid string (uuid)
resource_templates.requested_offering_plan any
resource_templates.created_by string (uri)
resource_templates.created_by_name string
resource_templates.created string (date-time)
fixed_duration_in_days integer
backend_id string
external_url string (uri)
reviewer_identity_visible_to_submitters boolean Whether proposal applicants can see reviewer identities
reviews_visible_to_submitters boolean Whether proposal applicants can see review comments and scores
has_eligibility_restrictions boolean Check if call has any eligibility restrictions configured.
created_by string (uri)
reference_code string
compliance_checklist string (uuid) Compliance checklist that proposals must complete before submission
compliance_checklist_name string
proposal_slug_template string Template for proposal slugs. Supports: {call_slug}, {round_slug}, {org_slug}, {year}, {month}, {counter}, {counter_padded}. Default: {round_slug}-{counter_padded}
user_email_patterns any List of email regex patterns. User must match one.
user_affiliations any List of allowed affiliations. User must have one.
user_identity_sources any List of allowed identity sources (identity providers).
user_nationalities any List of allowed nationality codes (ISO 3166-1 alpha-2). User must have one.
user_organization_types any List of allowed organization type URNs (SCHAC). User must match one.
user_assurance_levels any List of required assurance URIs (REFEDS). User must have ALL of these.

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/proposal-protected-calls/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.protected_call_field_enum import ProtectedCallFieldEnum # (1)
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_retrieve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = proposal_protected_calls_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. Model Source: ProtectedCallFieldEnum
  2. API Source: proposal_protected_calls_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { proposalProtectedCallsRetrieve } from 'waldur-js-client';

try {
  const response = await proposalProtectedCallsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type
field array

200 -

Field Type Description
url string (uri)
uuid string (uuid)
created string (date-time)
start_date string (date-time)
end_date string (date-time)
slug string URL-friendly identifier. Only editable by staff users.
name string
description string
state any
manager string (uri)
manager_uuid string (uuid)
customer_name string
customer_uuid string (uuid)
offerings array of objects
offerings.uuid string (uuid)
offerings.state any
offerings.offering string (uri)
offerings.offering_name string
offerings.offering_uuid string (uuid)
offerings.provider_name string
offerings.category_uuid string (uuid)
offerings.category_name string
offerings.call_managing_organisation string
offerings.attributes any
offerings.plan string (uri)
offerings.plan_details any
offerings.options any
offerings.components array of objects
offerings.components.uuid string (uuid)
offerings.components.billing_type string
Enum: fixed, usage, limit, one, few
offerings.components.type string Unique internal name of the measured unit, for example floating_ip.
offerings.components.name string Display name for the measured unit, for example, Floating IP.
offerings.components.description string
offerings.components.measured_unit string Unit of measurement, for example, GB.
offerings.components.unit_factor integer The conversion factor from backend units to measured_unit
offerings.components.limit_period any
offerings.components.limit_amount integer
offerings.components.article_code string
offerings.components.max_value integer
offerings.components.min_value integer
offerings.components.max_available_limit integer
offerings.components.is_boolean boolean
offerings.components.default_limit integer
offerings.components.factor integer
offerings.components.is_builtin boolean
offerings.components.is_prepaid boolean
offerings.components.overage_component string (uuid)
offerings.components.min_prepaid_duration integer
offerings.components.max_prepaid_duration integer
offerings.created string (date-time)
rounds array of objects
rounds.uuid string (uuid)
rounds.slug string
rounds.name string
rounds.start_time string (date-time)
rounds.cutoff_time string (date-time)
rounds.status any
rounds.review_strategy string
Enum: after_round, after_proposal
rounds.deciding_entity string
Enum: by_call_manager, automatic
rounds.allocation_time string
Enum: on_decision, fixed_date
rounds.allocation_date string (date-time)
rounds.minimal_average_scoring string (decimal)
rounds.review_duration_in_days integer
rounds.minimum_number_of_reviewers integer
documents array of objects
documents.uuid string (uuid)
documents.file string (uri) Documentation for call for proposals.
documents.file_name string
documents.file_size integer
documents.description string
documents.created string (date-time)
resource_templates array of objects
resource_templates.uuid string (uuid)
resource_templates.url string
resource_templates.name string
resource_templates.description string
resource_templates.attributes any
resource_templates.limits any
resource_templates.is_required boolean If True, every proposal must include this resource type
resource_templates.requested_offering string (uri)
resource_templates.requested_offering_name string
resource_templates.requested_offering_uuid string (uuid)
resource_templates.requested_offering_plan any
resource_templates.created_by string (uri)
resource_templates.created_by_name string
resource_templates.created string (date-time)
fixed_duration_in_days integer
backend_id string
external_url string (uri)
reviewer_identity_visible_to_submitters boolean Whether proposal applicants can see reviewer identities
reviews_visible_to_submitters boolean Whether proposal applicants can see review comments and scores
has_eligibility_restrictions boolean Check if call has any eligibility restrictions configured.
created_by string (uri)
reference_code string
compliance_checklist string (uuid) Compliance checklist that proposals must complete before submission
compliance_checklist_name string
proposal_slug_template string Template for proposal slugs. Supports: {call_slug}, {round_slug}, {org_slug}, {year}, {month}, {counter}, {counter_padded}. Default: {round_slug}-{counter_padded}
user_email_patterns any List of email regex patterns. User must match one.
user_affiliations any List of allowed affiliations. User must have one.
user_identity_sources any List of allowed identity sources (identity providers).
user_nationalities any List of allowed nationality codes (ISO 3166-1 alpha-2). User must have one.
user_organization_types any List of allowed organization type URNs (SCHAC). User must match one.
user_assurance_levels any List of required assurance URIs (REFEDS). User must have ALL of these.

Create

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/proposal-protected-calls/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-proposal-protected-call" \
  manager="https://api.example.com/api/manager/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.protected_call_request import ProtectedCallRequest # (1)
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ProtectedCallRequest(
    name="my-awesome-proposal-protected-call",
    manager="https://api.example.com/api/manager/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = proposal_protected_calls_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ProtectedCallRequest
  2. API Source: proposal_protected_calls_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { proposalProtectedCallsCreate } from 'waldur-js-client';

try {
  const response = await proposalProtectedCallsCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "name": "my-awesome-proposal-protected-call",
    "manager": "https://api.example.com/api/manager/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
slug string URL-friendly identifier. Only editable by staff users.
name string ✓
description string
manager string (uri) ✓
fixed_duration_in_days integer
backend_id string
external_url string (uri)
reviewer_identity_visible_to_submitters boolean Whether proposal applicants can see reviewer identities
reviews_visible_to_submitters boolean Whether proposal applicants can see review comments and scores
created_by string (uri)
reference_code string
compliance_checklist string (uuid) Compliance checklist that proposals must complete before submission
proposal_slug_template string Template for proposal slugs. Supports: {call_slug}, {round_slug}, {org_slug}, {year}, {month}, {counter}, {counter_padded}. Default: {round_slug}-{counter_padded}
user_email_patterns any List of email regex patterns. User must match one.
user_affiliations any List of allowed affiliations. User must have one.
user_identity_sources any List of allowed identity sources (identity providers).
user_nationalities any List of allowed nationality codes (ISO 3166-1 alpha-2). User must have one.
user_organization_types any List of allowed organization type URNs (SCHAC). User must match one.
user_assurance_levels any List of required assurance URIs (REFEDS). User must have ALL of these.

201 -

Field Type Description
url string (uri)
uuid string (uuid)
created string (date-time)
start_date string (date-time)
end_date string (date-time)
slug string URL-friendly identifier. Only editable by staff users.
name string
description string
state any
manager string (uri)
manager_uuid string (uuid)
customer_name string
customer_uuid string (uuid)
offerings array of objects
offerings.uuid string (uuid)
offerings.state any
offerings.offering string (uri)
offerings.offering_name string
offerings.offering_uuid string (uuid)
offerings.provider_name string
offerings.category_uuid string (uuid)
offerings.category_name string
offerings.call_managing_organisation string
offerings.attributes any
offerings.plan string (uri)
offerings.plan_details any
offerings.options any
offerings.components array of objects
offerings.components.uuid string (uuid)
offerings.components.billing_type string
Enum: fixed, usage, limit, one, few
offerings.components.type string Unique internal name of the measured unit, for example floating_ip.
offerings.components.name string Display name for the measured unit, for example, Floating IP.
offerings.components.description string
offerings.components.measured_unit string Unit of measurement, for example, GB.
offerings.components.unit_factor integer The conversion factor from backend units to measured_unit
offerings.components.limit_period any
offerings.components.limit_amount integer
offerings.components.article_code string
offerings.components.max_value integer
offerings.components.min_value integer
offerings.components.max_available_limit integer
offerings.components.is_boolean boolean
offerings.components.default_limit integer
offerings.components.factor integer
offerings.components.is_builtin boolean
offerings.components.is_prepaid boolean
offerings.components.overage_component string (uuid)
offerings.components.min_prepaid_duration integer
offerings.components.max_prepaid_duration integer
offerings.created string (date-time)
rounds array of objects
rounds.uuid string (uuid)
rounds.slug string
rounds.name string
rounds.start_time string (date-time)
rounds.cutoff_time string (date-time)
rounds.status any
rounds.review_strategy string
Enum: after_round, after_proposal
rounds.deciding_entity string
Enum: by_call_manager, automatic
rounds.allocation_time string
Enum: on_decision, fixed_date
rounds.allocation_date string (date-time)
rounds.minimal_average_scoring string (decimal)
rounds.review_duration_in_days integer
rounds.minimum_number_of_reviewers integer
documents array of objects
documents.uuid string (uuid)
documents.file string (uri) Documentation for call for proposals.
documents.file_name string
documents.file_size integer
documents.description string
documents.created string (date-time)
resource_templates array of objects
resource_templates.uuid string (uuid)
resource_templates.url string
resource_templates.name string
resource_templates.description string
resource_templates.attributes any
resource_templates.limits any
resource_templates.is_required boolean If True, every proposal must include this resource type
resource_templates.requested_offering string (uri)
resource_templates.requested_offering_name string
resource_templates.requested_offering_uuid string (uuid)
resource_templates.requested_offering_plan any
resource_templates.created_by string (uri)
resource_templates.created_by_name string
resource_templates.created string (date-time)
fixed_duration_in_days integer
backend_id string
external_url string (uri)
reviewer_identity_visible_to_submitters boolean Whether proposal applicants can see reviewer identities
reviews_visible_to_submitters boolean Whether proposal applicants can see review comments and scores
has_eligibility_restrictions boolean Check if call has any eligibility restrictions configured.
created_by string (uri)
reference_code string
compliance_checklist string (uuid) Compliance checklist that proposals must complete before submission
compliance_checklist_name string
proposal_slug_template string Template for proposal slugs. Supports: {call_slug}, {round_slug}, {org_slug}, {year}, {month}, {counter}, {counter_padded}. Default: {round_slug}-{counter_padded}
user_email_patterns any List of email regex patterns. User must match one.
user_affiliations any List of allowed affiliations. User must have one.
user_identity_sources any List of allowed identity sources (identity providers).
user_nationalities any List of allowed nationality codes (ISO 3166-1 alpha-2). User must have one.
user_organization_types any List of allowed organization type URNs (SCHAC). User must match one.
user_assurance_levels any List of required assurance URIs (REFEDS). User must have ALL of these.

Create manual assignment

Create a manual assignment batch for a specific reviewer. This allows call managers to manually assign proposals to reviewers.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/proposal-protected-calls/a1b2c3d4-e5f6-7890-abcd-ef1234567890/create-manual-assignment/ \
  Authorization:"Token YOUR_API_TOKEN" \
  reviewer_pool_entry_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  proposal_uuids:='[]'

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.create_manual_assignment_request import CreateManualAssignmentRequest # (1)
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_create_manual_assignment # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = CreateManualAssignmentRequest(
    reviewer_pool_entry_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    proposal_uuids=[]
)
response = proposal_protected_calls_create_manual_assignment.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: CreateManualAssignmentRequest
  2. API Source: proposal_protected_calls_create_manual_assignment
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { proposalProtectedCallsCreateManualAssignment } from 'waldur-js-client';

try {
  const response = await proposalProtectedCallsCreateManualAssignment({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "reviewer_pool_entry_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "proposal_uuids": []
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
reviewer_pool_entry_uuid string (uuid) ✓ UUID of the reviewer pool entry to assign proposals to
proposal_uuids array of string (uuid)s ✓ List of proposal UUIDs to assign to the reviewer
manager_notes string Optional notes about this assignment

200 -

Field Type Description
batch_uuid string (uuid)
items_created integer
skipped_proposals array of objects Proposals that were skipped with reasons

Create or update applicant attribute exposure configuration

Create or update applicant attribute exposure configuration.

1
2
3
4
http \
  POST \
  https://api.example.com/api/proposal-protected-calls/a1b2c3d4-e5f6-7890-abcd-ef1234567890/update_applicant_attribute_config/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.call_applicant_attribute_config_request import CallApplicantAttributeConfigRequest # (1)
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_update_applicant_attribute_config # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = CallApplicantAttributeConfigRequest()
response = proposal_protected_calls_update_applicant_attribute_config.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: CallApplicantAttributeConfigRequest
  2. API Source: proposal_protected_calls_update_applicant_attribute_config
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { proposalProtectedCallsUpdateApplicantAttributeConfig } from 'waldur-js-client';

try {
  const response = await proposalProtectedCallsUpdateApplicantAttributeConfig({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
call string (uuid)
Constraints: write-only
expose_full_name boolean
expose_email boolean
expose_organization boolean
expose_affiliations boolean
expose_organization_type boolean
expose_organization_country boolean
expose_nationality boolean
expose_nationalities boolean
expose_country_of_residence boolean
expose_eduperson_assurance boolean
expose_identity_source boolean
reviewers_see_applicant_details boolean If True, reviewers see applicant identity. If False, proposals are anonymized for reviewers.

200 -

Field Type Description
uuid string (uuid)
call_uuid string (uuid)
call_name string
expose_full_name boolean
expose_email boolean
expose_organization boolean
expose_affiliations boolean
expose_organization_type boolean
expose_organization_country boolean
expose_nationality boolean
expose_nationalities boolean
expose_country_of_residence boolean
expose_eduperson_assurance boolean
expose_identity_source boolean
reviewers_see_applicant_details boolean If True, reviewers see applicant identity. If False, proposals are anonymized for reviewers.
exposed_fields array of strings Return list of currently exposed field names.
is_default boolean Return True if this is a default (unsaved) config.

Update

1
2
3
4
5
6
http \
  PUT \
  https://api.example.com/api/proposal-protected-calls/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-proposal-protected-call" \
  manager="https://api.example.com/api/manager/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.protected_call_request import ProtectedCallRequest # (1)
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ProtectedCallRequest(
    name="my-awesome-proposal-protected-call",
    manager="https://api.example.com/api/manager/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = proposal_protected_calls_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ProtectedCallRequest
  2. API Source: proposal_protected_calls_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { proposalProtectedCallsUpdate } from 'waldur-js-client';

try {
  const response = await proposalProtectedCallsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-proposal-protected-call",
    "manager": "https://api.example.com/api/manager/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
slug string URL-friendly identifier. Only editable by staff users.
name string ✓
description string
manager string (uri) ✓
fixed_duration_in_days integer
backend_id string
external_url string (uri)
reviewer_identity_visible_to_submitters boolean Whether proposal applicants can see reviewer identities
reviews_visible_to_submitters boolean Whether proposal applicants can see review comments and scores
created_by string (uri)
reference_code string
compliance_checklist string (uuid) Compliance checklist that proposals must complete before submission
proposal_slug_template string Template for proposal slugs. Supports: {call_slug}, {round_slug}, {org_slug}, {year}, {month}, {counter}, {counter_padded}. Default: {round_slug}-{counter_padded}
user_email_patterns any List of email regex patterns. User must match one.
user_affiliations any List of allowed affiliations. User must have one.
user_identity_sources any List of allowed identity sources (identity providers).
user_nationalities any List of allowed nationality codes (ISO 3166-1 alpha-2). User must have one.
user_organization_types any List of allowed organization type URNs (SCHAC). User must match one.
user_assurance_levels any List of required assurance URIs (REFEDS). User must have ALL of these.

200 -

Field Type Description
url string (uri)
uuid string (uuid)
created string (date-time)
start_date string (date-time)
end_date string (date-time)
slug string URL-friendly identifier. Only editable by staff users.
name string
description string
state any
manager string (uri)
manager_uuid string (uuid)
customer_name string
customer_uuid string (uuid)
offerings array of objects
offerings.uuid string (uuid)
offerings.state any
offerings.offering string (uri)
offerings.offering_name string
offerings.offering_uuid string (uuid)
offerings.provider_name string
offerings.category_uuid string (uuid)
offerings.category_name string
offerings.call_managing_organisation string
offerings.attributes any
offerings.plan string (uri)
offerings.plan_details any
offerings.options any
offerings.components array of objects
offerings.components.uuid string (uuid)
offerings.components.billing_type string
Enum: fixed, usage, limit, one, few
offerings.components.type string Unique internal name of the measured unit, for example floating_ip.
offerings.components.name string Display name for the measured unit, for example, Floating IP.
offerings.components.description string
offerings.components.measured_unit string Unit of measurement, for example, GB.
offerings.components.unit_factor integer The conversion factor from backend units to measured_unit
offerings.components.limit_period any
offerings.components.limit_amount integer
offerings.components.article_code string
offerings.components.max_value integer
offerings.components.min_value integer
offerings.components.max_available_limit integer
offerings.components.is_boolean boolean
offerings.components.default_limit integer
offerings.components.factor integer
offerings.components.is_builtin boolean
offerings.components.is_prepaid boolean
offerings.components.overage_component string (uuid)
offerings.components.min_prepaid_duration integer
offerings.components.max_prepaid_duration integer
offerings.created string (date-time)
rounds array of objects
rounds.uuid string (uuid)
rounds.slug string
rounds.name string
rounds.start_time string (date-time)
rounds.cutoff_time string (date-time)
rounds.status any
rounds.review_strategy string
Enum: after_round, after_proposal
rounds.deciding_entity string
Enum: by_call_manager, automatic
rounds.allocation_time string
Enum: on_decision, fixed_date
rounds.allocation_date string (date-time)
rounds.minimal_average_scoring string (decimal)
rounds.review_duration_in_days integer
rounds.minimum_number_of_reviewers integer
documents array of objects
documents.uuid string (uuid)
documents.file string (uri) Documentation for call for proposals.
documents.file_name string
documents.file_size integer
documents.description string
documents.created string (date-time)
resource_templates array of objects
resource_templates.uuid string (uuid)
resource_templates.url string
resource_templates.name string
resource_templates.description string
resource_templates.attributes any
resource_templates.limits any
resource_templates.is_required boolean If True, every proposal must include this resource type
resource_templates.requested_offering string (uri)
resource_templates.requested_offering_name string
resource_templates.requested_offering_uuid string (uuid)
resource_templates.requested_offering_plan any
resource_templates.created_by string (uri)
resource_templates.created_by_name string
resource_templates.created string (date-time)
fixed_duration_in_days integer
backend_id string
external_url string (uri)
reviewer_identity_visible_to_submitters boolean Whether proposal applicants can see reviewer identities
reviews_visible_to_submitters boolean Whether proposal applicants can see review comments and scores
has_eligibility_restrictions boolean Check if call has any eligibility restrictions configured.
created_by string (uri)
reference_code string
compliance_checklist string (uuid) Compliance checklist that proposals must complete before submission
compliance_checklist_name string
proposal_slug_template string Template for proposal slugs. Supports: {call_slug}, {round_slug}, {org_slug}, {year}, {month}, {counter}, {counter_padded}. Default: {round_slug}-{counter_padded}
user_email_patterns any List of email regex patterns. User must match one.
user_affiliations any List of allowed affiliations. User must have one.
user_identity_sources any List of allowed identity sources (identity providers).
user_nationalities any List of allowed nationality codes (ISO 3166-1 alpha-2). User must have one.
user_organization_types any List of allowed organization type URNs (SCHAC). User must match one.
user_assurance_levels any List of required assurance URIs (REFEDS). User must have ALL of these.

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/proposal-protected-calls/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_protected_call_request import PatchedProtectedCallRequest # (1)
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedProtectedCallRequest()
response = proposal_protected_calls_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedProtectedCallRequest
  2. API Source: proposal_protected_calls_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { proposalProtectedCallsPartialUpdate } from 'waldur-js-client';

try {
  const response = await proposalProtectedCallsPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
slug string URL-friendly identifier. Only editable by staff users.
name string
description string
fixed_duration_in_days integer
backend_id string
external_url string (uri)
reviewer_identity_visible_to_submitters boolean Whether proposal applicants can see reviewer identities
reviews_visible_to_submitters boolean Whether proposal applicants can see review comments and scores
created_by string (uri)
reference_code string
compliance_checklist string (uuid) Compliance checklist that proposals must complete before submission
proposal_slug_template string Template for proposal slugs. Supports: {call_slug}, {round_slug}, {org_slug}, {year}, {month}, {counter}, {counter_padded}. Default: {round_slug}-{counter_padded}
user_email_patterns any List of email regex patterns. User must match one.
user_affiliations any List of allowed affiliations. User must have one.
user_identity_sources any List of allowed identity sources (identity providers).
user_nationalities any List of allowed nationality codes (ISO 3166-1 alpha-2). User must have one.
user_organization_types any List of allowed organization type URNs (SCHAC). User must match one.
user_assurance_levels any List of required assurance URIs (REFEDS). User must have ALL of these.

200 -

Field Type Description
url string (uri)
uuid string (uuid)
created string (date-time)
start_date string (date-time)
end_date string (date-time)
slug string URL-friendly identifier. Only editable by staff users.
name string
description string
state any
manager string (uri)
manager_uuid string (uuid)
customer_name string
customer_uuid string (uuid)
offerings array of objects
offerings.uuid string (uuid)
offerings.state any
offerings.offering string (uri)
offerings.offering_name string
offerings.offering_uuid string (uuid)
offerings.provider_name string
offerings.category_uuid string (uuid)
offerings.category_name string
offerings.call_managing_organisation string
offerings.attributes any
offerings.plan string (uri)
offerings.plan_details any
offerings.options any
offerings.components array of objects
offerings.components.uuid string (uuid)
offerings.components.billing_type string
Enum: fixed, usage, limit, one, few
offerings.components.type string Unique internal name of the measured unit, for example floating_ip.
offerings.components.name string Display name for the measured unit, for example, Floating IP.
offerings.components.description string
offerings.components.measured_unit string Unit of measurement, for example, GB.
offerings.components.unit_factor integer The conversion factor from backend units to measured_unit
offerings.components.limit_period any
offerings.components.limit_amount integer
offerings.components.article_code string
offerings.components.max_value integer
offerings.components.min_value integer
offerings.components.max_available_limit integer
offerings.components.is_boolean boolean
offerings.components.default_limit integer
offerings.components.factor integer
offerings.components.is_builtin boolean
offerings.components.is_prepaid boolean
offerings.components.overage_component string (uuid)
offerings.components.min_prepaid_duration integer
offerings.components.max_prepaid_duration integer
offerings.created string (date-time)
rounds array of objects
rounds.uuid string (uuid)
rounds.slug string
rounds.name string
rounds.start_time string (date-time)
rounds.cutoff_time string (date-time)
rounds.status any
rounds.review_strategy string
Enum: after_round, after_proposal
rounds.deciding_entity string
Enum: by_call_manager, automatic
rounds.allocation_time string
Enum: on_decision, fixed_date
rounds.allocation_date string (date-time)
rounds.minimal_average_scoring string (decimal)
rounds.review_duration_in_days integer
rounds.minimum_number_of_reviewers integer
documents array of objects
documents.uuid string (uuid)
documents.file string (uri) Documentation for call for proposals.
documents.file_name string
documents.file_size integer
documents.description string
documents.created string (date-time)
resource_templates array of objects
resource_templates.uuid string (uuid)
resource_templates.url string
resource_templates.name string
resource_templates.description string
resource_templates.attributes any
resource_templates.limits any
resource_templates.is_required boolean If True, every proposal must include this resource type
resource_templates.requested_offering string (uri)
resource_templates.requested_offering_name string
resource_templates.requested_offering_uuid string (uuid)
resource_templates.requested_offering_plan any
resource_templates.created_by string (uri)
resource_templates.created_by_name string
resource_templates.created string (date-time)
fixed_duration_in_days integer
backend_id string
external_url string (uri)
reviewer_identity_visible_to_submitters boolean Whether proposal applicants can see reviewer identities
reviews_visible_to_submitters boolean Whether proposal applicants can see review comments and scores
has_eligibility_restrictions boolean Check if call has any eligibility restrictions configured.
created_by string (uri)
reference_code string
compliance_checklist string (uuid) Compliance checklist that proposals must complete before submission
compliance_checklist_name string
proposal_slug_template string Template for proposal slugs. Supports: {call_slug}, {round_slug}, {org_slug}, {year}, {month}, {counter}, {counter_padded}. Default: {round_slug}-{counter_padded}
user_email_patterns any List of email regex patterns. User must match one.
user_affiliations any List of allowed affiliations. User must have one.
user_identity_sources any List of allowed identity sources (identity providers).
user_nationalities any List of allowed nationality codes (ISO 3166-1 alpha-2). User must have one.
user_organization_types any List of allowed organization type URNs (SCHAC). User must match one.
user_assurance_levels any List of required assurance URIs (REFEDS). User must have ALL of these.

Create or update applicant attribute exposure configuration

Create or update applicant attribute exposure configuration.

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/proposal-protected-calls/a1b2c3d4-e5f6-7890-abcd-ef1234567890/update_applicant_attribute_config/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_call_applicant_attribute_config_request import PatchedCallApplicantAttributeConfigRequest # (1)
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_update_applicant_attribute_config_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedCallApplicantAttributeConfigRequest()
response = proposal_protected_calls_update_applicant_attribute_config_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedCallApplicantAttributeConfigRequest
  2. API Source: proposal_protected_calls_update_applicant_attribute_config_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { proposalProtectedCallsUpdateApplicantAttributeConfigPartialUpdate } from 'waldur-js-client';

try {
  const response = await proposalProtectedCallsUpdateApplicantAttributeConfigPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
call string (uuid)
Constraints: write-only
expose_full_name boolean
expose_email boolean
expose_organization boolean
expose_affiliations boolean
expose_organization_type boolean
expose_organization_country boolean
expose_nationality boolean
expose_nationalities boolean
expose_country_of_residence boolean
expose_eduperson_assurance boolean
expose_identity_source boolean
reviewers_see_applicant_details boolean If True, reviewers see applicant identity. If False, proposals are anonymized for reviewers.

200 -

Field Type Description
uuid string (uuid)
call_uuid string (uuid)
call_name string
expose_full_name boolean
expose_email boolean
expose_organization boolean
expose_affiliations boolean
expose_organization_type boolean
expose_organization_country boolean
expose_nationality boolean
expose_nationalities boolean
expose_country_of_residence boolean
expose_eduperson_assurance boolean
expose_identity_source boolean
reviewers_see_applicant_details boolean If True, reviewers see applicant identity. If False, proposals are anonymized for reviewers.
exposed_fields array of strings Return list of currently exposed field names.
is_default boolean Return True if this is a default (unsaved) config.

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/proposal-protected-calls/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = proposal_protected_calls_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: proposal_protected_calls_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { proposalProtectedCallsDestroy } from 'waldur-js-client';

try {
  const response = await proposalProtectedCallsDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Permissions & Users

List users and their roles in a scope

Retrieves a list of users who have a role within a specific scope (e.g., a project or an organization). The list can be filtered by user details or role.

1
2
3
4
http \
  GET \
  https://api.example.com/api/proposal-protected-calls/a1b2c3d4-e5f6-7890-abcd-ef1234567890/list_users/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.user_role_details_field_enum import UserRoleDetailsFieldEnum # (1)
from waldur_api_client.models.user_role_details_o_enum import UserRoleDetailsOEnum # (2)
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_list_users_list # (3)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = proposal_protected_calls_list_users_list.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

for item in response:
    print(item)
  1. Model Source: UserRoleDetailsFieldEnum
  2. Model Source: UserRoleDetailsOEnum
  3. API Source: proposal_protected_calls_list_users_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { proposalProtectedCallsListUsersList } from 'waldur-js-client';

try {
  const response = await proposalProtectedCallsListUsersList({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type Description
field array Fields to include in response
full_name string User full name
native_name string User native name
o array Ordering fields
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
role string (uuid) Role UUID or name
search_string string Search string for user
user string (uuid) User UUID
user_slug string User slug
user_url string User URL
username string User username

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid)
created string (date-time)
expiration_time string (date-time)
role_name string
role_uuid string (uuid)
user_email string (email)
user_full_name string
user_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
user_uuid string (uuid)
user_image string (uri)
created_by_full_name string
created_by_uuid string (uuid)

Grant a role to a user

Assigns a specific role to a user within the current scope. An optional expiration time for the role can be set.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/proposal-protected-calls/a1b2c3d4-e5f6-7890-abcd-ef1234567890/add_user/ \
  Authorization:"Token YOUR_API_TOKEN" \
  role="string-value" \
  user="a1b2c3d4-e5f6-7890-abcd-ef1234567890"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.user_role_create_request import UserRoleCreateRequest # (1)
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_add_user # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = UserRoleCreateRequest(
    role="string-value",
    user="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
)
response = proposal_protected_calls_add_user.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: UserRoleCreateRequest
  2. API Source: proposal_protected_calls_add_user
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { proposalProtectedCallsAddUser } from 'waldur-js-client';

try {
  const response = await proposalProtectedCallsAddUser({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "role": "string-value",
    "user": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
role string ✓
user string (uuid) ✓
expiration_time string (date-time)

201 -

Field Type
expiration_time string (date-time)

400 - Validation error, for example when trying to add a user to a terminated project.

Revoke a role from a user

Removes a specific role from a user within the current scope. This effectively revokes their permissions associated with that role.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/proposal-protected-calls/a1b2c3d4-e5f6-7890-abcd-ef1234567890/delete_user/ \
  Authorization:"Token YOUR_API_TOKEN" \
  role="string-value" \
  user="a1b2c3d4-e5f6-7890-abcd-ef1234567890"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.user_role_delete_request import UserRoleDeleteRequest # (1)
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_delete_user # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = UserRoleDeleteRequest(
    role="string-value",
    user="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
)
response = proposal_protected_calls_delete_user.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: UserRoleDeleteRequest
  2. API Source: proposal_protected_calls_delete_user
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { proposalProtectedCallsDeleteUser } from 'waldur-js-client';

try {
  const response = await proposalProtectedCallsDeleteUser({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "role": "string-value",
    "user": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
role string ✓
user string (uuid) ✓
expiration_time string (date-time)

200 - Role revoked successfully.

Update a user's role expiration

Updates the expiration time for a user's existing role in the current scope. This is useful for extending or shortening the duration of a permission. To make a role permanent, set expiration_time to null.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/proposal-protected-calls/a1b2c3d4-e5f6-7890-abcd-ef1234567890/update_user/ \
  Authorization:"Token YOUR_API_TOKEN" \
  role="string-value" \
  user="a1b2c3d4-e5f6-7890-abcd-ef1234567890"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.user_role_update_request import UserRoleUpdateRequest # (1)
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_update_user # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = UserRoleUpdateRequest(
    role="string-value",
    user="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
)
response = proposal_protected_calls_update_user.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: UserRoleUpdateRequest
  2. API Source: proposal_protected_calls_update_user
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { proposalProtectedCallsUpdateUser } from 'waldur-js-client';

try {
  const response = await proposalProtectedCallsUpdateUser({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "role": "string-value",
    "user": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
role string ✓
user string (uuid) ✓
expiration_time string (date-time)

200 -

Field Type
expiration_time string (date-time)

Other Actions

Get affinity matrix for reviewer-proposal matching

Get affinity matrix for reviewer-proposal matching.

1
2
3
4
http \
  GET \
  https://api.example.com/api/proposal-protected-calls/a1b2c3d4-e5f6-7890-abcd-ef1234567890/affinity-matrix/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.affinity_matrix_response_scope_enum import AffinityMatrixResponseScopeEnum # (1)
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_affinity_matrix_retrieve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = proposal_protected_calls_affinity_matrix_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. Model Source: AffinityMatrixResponseScopeEnum
  2. API Source: proposal_protected_calls_affinity_matrix_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { proposalProtectedCallsAffinityMatrixRetrieve } from 'waldur-js-client';

try {
  const response = await proposalProtectedCallsAffinityMatrixRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type Description
scope string Filter by reviewer source: 'pool' (accepted reviewers), 'suggestions' (suggested reviewers), or 'all' (both). Default: 'pool'
Enum: all, pool, suggestions

200 -

Field Type
count integer
results array of objects
results.uuid string (uuid)
results.reviewer_uuid string (uuid)
results.reviewer_name string
results.proposal_uuid string (uuid)
results.proposal_name string
results.affinity_score number (double)
results.keyword_score number (double)
results.text_score number (double)
results.has_conflict boolean
results.coi_type string
results.coi_severity string
results.coi_status string
results.source string

Get applicant attribute exposure configuration for this call

Get applicant attribute exposure configuration for this call.

1
2
3
4
http \
  GET \
  https://api.example.com/api/proposal-protected-calls/a1b2c3d4-e5f6-7890-abcd-ef1234567890/applicant_attribute_config/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_applicant_attribute_config_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = proposal_protected_calls_applicant_attribute_config_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: proposal_protected_calls_applicant_attribute_config_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { proposalProtectedCallsApplicantAttributeConfigRetrieve } from 'waldur-js-client';

try {
  const response = await proposalProtectedCallsApplicantAttributeConfigRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
uuid string (uuid)
call_uuid string (uuid)
call_name string
expose_full_name boolean
expose_email boolean
expose_organization boolean
expose_affiliations boolean
expose_organization_type boolean
expose_organization_country boolean
expose_nationality boolean
expose_nationalities boolean
expose_country_of_residence boolean
expose_eduperson_assurance boolean
expose_identity_source boolean
reviewers_see_applicant_details boolean If True, reviewers see applicant identity. If False, proposals are anonymized for reviewers.
exposed_fields array of strings Return list of currently exposed field names.
is_default boolean Return True if this is a default (unsaved) config.

Get available compliance checklists for call creation/editing

Get available compliance checklists for call creation/editing.

1
2
3
4
5
http \
  GET \
  https://api.example.com/api/proposal-protected-calls/available_compliance_checklists/ \
  Authorization:"Token YOUR_API_TOKEN" \
  customer_uuid=="a1b2c3d4-e5f6-7890-abcd-ef1234567890"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.call_states import CallStates # (1)
from waldur_api_client.models.protected_call_o_enum import ProtectedCallOEnum # (2)
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_available_compliance_checklists_list # (3)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = proposal_protected_calls_available_compliance_checklists_list.sync(
    client=client,
    customer_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
)

for item in response:
    print(item)
  1. Model Source: CallStates
  2. Model Source: ProtectedCallOEnum
  3. API Source: proposal_protected_calls_available_compliance_checklists_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { proposalProtectedCallsAvailableComplianceChecklistsList } from 'waldur-js-client';

try {
  const response = await proposalProtectedCallsAvailableComplianceChecklistsList({
  auth: "Token YOUR_API_TOKEN",
  query: {
    "customer_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
checklist_type string Filter by checklist type (default: proposal_compliance)
customer string (uri)
customer_keyword string
customer_uuid string ✓ Customer UUID to check permissions for. Required to verify user has CREATE_CALL permission on that customer's call managing organization.
has_active_round boolean
name string
o array Ordering
offering_uuid string (uuid)
offerings_provider_uuid string (uuid)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
state array

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
uuid string (uuid)
name string
description string
checklist_type string
questions_count integer
category_name string
category_uuid string (uuid)

Get COI configuration for this call

Get COI configuration for this call.

1
2
3
4
http \
  GET \
  https://api.example.com/api/proposal-protected-calls/a1b2c3d4-e5f6-7890-abcd-ef1234567890/coi-configuration/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_coi_configuration_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = proposal_protected_calls_coi_configuration_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: proposal_protected_calls_coi_configuration_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { proposalProtectedCallsCoiConfigurationRetrieve } from 'waldur-js-client';

try {
  const response = await proposalProtectedCallsCoiConfigurationRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
uuid string (uuid)
call string (uri)
call_uuid string (uuid)
call_name string
coauthorship_lookback_years integer Years to look back for co-authorship detection
coauthorship_threshold_papers integer Minimum shared papers to trigger COI
institutional_lookback_years integer Years to look back for former institution detection
include_same_department boolean Detect same-department as COI
include_same_institution boolean Detect same-institution as COI
recusal_required_types array of strings COI types requiring automatic recusal
management_allowed_types array of strings COI types allowing management plan
disclosure_only_types array of strings COI types requiring disclosure only
auto_detect_coauthorship boolean Enable automated co-authorship detection
auto_detect_institutional boolean Enable automated institutional affiliation detection
auto_detect_named_personnel boolean Enable detection of reviewer named in proposals
invitation_proposal_disclosure any Level of proposal information disclosed in reviewer invitations
created string (date-time)
modified string (date-time)

Compliance overview

Get compliance overview for call manager showing all proposals and their compliance status.

1
2
3
4
http \
  GET \
  https://api.example.com/api/proposal-protected-calls/a1b2c3d4-e5f6-7890-abcd-ef1234567890/compliance_overview/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_compliance_overview_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = proposal_protected_calls_compliance_overview_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: proposal_protected_calls_compliance_overview_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { proposalProtectedCallsComplianceOverviewRetrieve } from 'waldur-js-client';

try {
  const response = await proposalProtectedCallsComplianceOverviewRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
checklist object (free-form)
proposals array of anys

Get summary statistics of conflicts for this call

Get summary statistics of conflicts for this call.

1
2
3
4
http \
  GET \
  https://api.example.com/api/proposal-protected-calls/a1b2c3d4-e5f6-7890-abcd-ef1234567890/conflict-summary/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_conflict_summary_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = proposal_protected_calls_conflict_summary_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: proposal_protected_calls_conflict_summary_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { proposalProtectedCallsConflictSummaryRetrieve } from 'waldur-js-client';

try {
  const response = await proposalProtectedCallsConflictSummaryRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
total integer
by_status object (free-form)
by_severity object (free-form)
by_type object (free-form)

List all conflicts of interest detected for this call

List all conflicts of interest detected for this call.

1
2
3
4
http \
  GET \
  https://api.example.com/api/proposal-protected-calls/a1b2c3d4-e5f6-7890-abcd-ef1234567890/conflicts/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.call_states import CallStates # (1)
from waldur_api_client.models.protected_call_o_enum import ProtectedCallOEnum # (2)
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_conflicts_list # (3)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = proposal_protected_calls_conflicts_list.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

for item in response:
    print(item)
  1. Model Source: CallStates
  2. Model Source: ProtectedCallOEnum
  3. API Source: proposal_protected_calls_conflicts_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { proposalProtectedCallsConflictsList } from 'waldur-js-client';

try {
  const response = await proposalProtectedCallsConflictsList({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type Description
customer string (uri)
customer_keyword string
customer_uuid string (uuid)
has_active_round boolean
name string
o array Ordering
offering_uuid string (uuid)
offerings_provider_uuid string (uuid)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
state array

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
reviewer string (uri)
reviewer_uuid string (uuid)
reviewer_name string
proposal string (uri)
proposal_uuid string (uuid)
proposal_name string
round_uuid string (uuid)
round_name string
call string (uri)
call_uuid string (uuid)
call_name string
coi_type any
coi_type_display string
severity any
severity_display string
detection_method any
detected_at string (date-time)
evidence_description string
evidence_data any Structured evidence: {"papers": [...], "affiliation_overlap": {...}}
status string
Enum: pending, dismissed, waived, recused
status_display string
reviewed_by string (uri)
reviewed_by_name string
reviewed_at string (date-time)
review_notes string
management_plan string If waived, how is it managed
conflicting_user string (uri) Specific person causing conflict
conflicting_user_name string
conflicting_organization string (uri)
conflicting_organization_name string
created string (date-time)

Get or update matching configuration for this call

Get or update matching configuration for this call.

1
2
3
4
http \
  GET \
  https://api.example.com/api/proposal-protected-calls/a1b2c3d4-e5f6-7890-abcd-ef1234567890/matching-configuration/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_matching_configuration_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = proposal_protected_calls_matching_configuration_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: proposal_protected_calls_matching_configuration_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { proposalProtectedCallsMatchingConfigurationRetrieve } from 'waldur-js-client';

try {
  const response = await proposalProtectedCallsMatchingConfigurationRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
uuid string (uuid)
call_uuid string (uuid)
call_name string
affinity_method string
Enum: keyword, tfidf, combined
keyword_weight number (double)
text_weight number (double)
min_reviewers_per_proposal integer
max_reviewers_per_proposal integer
min_proposals_per_reviewer integer
max_proposals_per_reviewer integer
algorithm string
Enum: minmax, fairflow, hungarian
min_affinity_threshold number (double) Minimum affinity score for FairFlow algorithm
use_reviewer_bids boolean
bid_weight number (double)
created string (date-time)
modified string (date-time)

List offerings for a call

List offerings for a call.

1
2
3
4
http \
  GET \
  https://api.example.com/api/proposal-protected-calls/a1b2c3d4-e5f6-7890-abcd-ef1234567890/offerings/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_offerings_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = proposal_protected_calls_offerings_list.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

for item in response:
    print(item)
  1. API Source: proposal_protected_calls_offerings_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { proposalProtectedCallsOfferingsList } from 'waldur-js-client';

try {
  const response = await proposalProtectedCallsOfferingsList({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
state string Filter by state

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid)
state any
offering string (uri)
offering_name string
offering_uuid string (uuid)
provider_name string
category_uuid string (uuid)
category_name string
call_managing_organisation string
attributes any
plan string (uri)
plan_details any
options any
components array of objects
components.uuid string (uuid)
components.billing_type string
Enum: fixed, usage, limit, one, few
components.type string Unique internal name of the measured unit, for example floating_ip.
components.name string Display name for the measured unit, for example, Floating IP.
components.description string
components.measured_unit string Unit of measurement, for example, GB.
components.unit_factor integer The conversion factor from backend units to measured_unit
components.limit_period any
components.limit_amount integer
components.article_code string
components.max_value integer
components.min_value integer
components.max_available_limit integer
components.is_boolean boolean
components.default_limit integer
components.factor integer
components.is_builtin boolean
components.is_prepaid boolean
components.overage_component string (uuid)
components.min_prepaid_duration integer
components.max_prepaid_duration integer
created string (date-time)
url string
approved_by string (uri)
created_by string (uri)
created_by_name string
approved_by_name string
description string

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/proposal-protected-calls/string-value/offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_offerings_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = proposal_protected_calls_offerings_retrieve.sync(
    obj_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    uuid="string-value",
    client=client
)

print(response)
  1. API Source: proposal_protected_calls_offerings_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { proposalProtectedCallsOfferingsRetrieve } from 'waldur-js-client';

try {
  const response = await proposalProtectedCallsOfferingsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "obj_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "uuid": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
obj_uuid string ✓
uuid string ✓

200 -

Field Type Description
uuid string (uuid)
state any
offering string (uri)
offering_name string
offering_uuid string (uuid)
provider_name string
category_uuid string (uuid)
category_name string
call_managing_organisation string
attributes any
plan string (uri)
plan_details any
options any
components array of objects
components.uuid string (uuid)
components.billing_type string
Enum: fixed, usage, limit, one, few
components.type string Unique internal name of the measured unit, for example floating_ip.
components.name string Display name for the measured unit, for example, Floating IP.
components.description string
components.measured_unit string Unit of measurement, for example, GB.
components.unit_factor integer The conversion factor from backend units to measured_unit
components.limit_period any
components.limit_amount integer
components.article_code string
components.max_value integer
components.min_value integer
components.max_available_limit integer
components.is_boolean boolean
components.default_limit integer
components.factor integer
components.is_builtin boolean
components.is_prepaid boolean
components.overage_component string (uuid)
components.min_prepaid_duration integer
components.max_prepaid_duration integer
created string (date-time)
url string
approved_by string (uri)
created_by string (uri)
created_by_name string
approved_by_name string
description string

Get detailed compliance answers for a specific proposal (call managers only)

Get detailed compliance answers for a specific proposal (call managers only).

1
2
3
4
http \
  GET \
  https://api.example.com/api/proposal-protected-calls/a1b2c3d4-e5f6-7890-abcd-ef1234567890/proposals/a1b2c3d4-e5f6-7890-abcd-ef1234567890/compliance-answers/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.call_states import CallStates # (1)
from waldur_api_client.models.protected_call_o_enum import ProtectedCallOEnum # (2)
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_proposals_compliance_answers_list # (3)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = proposal_protected_calls_proposals_compliance_answers_list.sync(
    proposal_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

for item in response:
    print(item)
  1. Model Source: CallStates
  2. Model Source: ProtectedCallOEnum
  3. API Source: proposal_protected_calls_proposals_compliance_answers_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { proposalProtectedCallsProposalsComplianceAnswersList } from 'waldur-js-client';

try {
  const response = await proposalProtectedCallsProposalsComplianceAnswersList({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "proposal_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
proposal_uuid string ✓ UUID of the proposal
uuid string (uuid) ✓
Name Type Description
customer string (uri)
customer_keyword string
customer_uuid string (uuid)
has_active_round boolean
name string
o array Ordering
offering_uuid string (uuid)
offerings_provider_uuid string (uuid)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
state array

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid)
question_description string
question_type string
question_required boolean
answer_data any Flexible answer storage for different question types
requires_review boolean Internal flag - this answer requires additional review
user integer
user_name string
created string (date-time)
modified string (date-time)

Get proposed reviewer-proposal assignments

Get proposed reviewer-proposal assignments.

1
2
3
4
http \
  GET \
  https://api.example.com/api/proposal-protected-calls/a1b2c3d4-e5f6-7890-abcd-ef1234567890/proposed-assignments/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.call_states import CallStates # (1)
from waldur_api_client.models.protected_call_o_enum import ProtectedCallOEnum # (2)
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_proposed_assignments_list # (3)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = proposal_protected_calls_proposed_assignments_list.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

for item in response:
    print(item)
  1. Model Source: CallStates
  2. Model Source: ProtectedCallOEnum
  3. API Source: proposal_protected_calls_proposed_assignments_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { proposalProtectedCallsProposedAssignmentsList } from 'waldur-js-client';

try {
  const response = await proposalProtectedCallsProposedAssignmentsList({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type Description
customer string (uri)
customer_keyword string
customer_uuid string (uuid)
has_active_round boolean
name string
o array Ordering
offering_uuid string (uuid)
offerings_provider_uuid string (uuid)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
state array

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
call string (uri)
reviewer string (uri)
reviewer_uuid string (uuid)
reviewer_name string
proposal string (uri)
proposal_uuid string (uuid)
proposal_name string
affinity_score number (double)
algorithm_used any
rank integer Assignment rank (1 = best match)
is_deployed boolean
deployed_at string (date-time)
deployed_by string (uri)
deployed_by_name string
created string (date-time)

List resource templates for a call

List resource templates for a call.

1
2
3
4
http \
  GET \
  https://api.example.com/api/proposal-protected-calls/a1b2c3d4-e5f6-7890-abcd-ef1234567890/resource_templates/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_resource_templates_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = proposal_protected_calls_resource_templates_list.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

for item in response:
    print(item)
  1. API Source: proposal_protected_calls_resource_templates_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { proposalProtectedCallsResourceTemplatesList } from 'waldur-js-client';

try {
  const response = await proposalProtectedCallsResourceTemplatesList({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid)
url string
name string
description string
attributes any
limits any
is_required boolean If True, every proposal must include this resource type
requested_offering string (uri)
requested_offering_name string
requested_offering_uuid string (uuid)
requested_offering_plan any
created_by string (uri)
created_by_name string
created string (date-time)

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/proposal-protected-calls/string-value/resource_templates/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_resource_templates_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = proposal_protected_calls_resource_templates_retrieve.sync(
    obj_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    uuid="string-value",
    client=client
)

print(response)
  1. API Source: proposal_protected_calls_resource_templates_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { proposalProtectedCallsResourceTemplatesRetrieve } from 'waldur-js-client';

try {
  const response = await proposalProtectedCallsResourceTemplatesRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "obj_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "uuid": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
obj_uuid string ✓
uuid string ✓

200 -

Field Type Description
uuid string (uuid)
url string
name string
description string
attributes any
limits any
is_required boolean If True, every proposal must include this resource type
requested_offering string (uri)
requested_offering_name string
requested_offering_uuid string (uuid)
requested_offering_plan any
created_by string (uri)
created_by_name string
created string (date-time)

List reviewer pool members for a call

List reviewer pool members for a call.

1
2
3
4
http \
  GET \
  https://api.example.com/api/proposal-protected-calls/a1b2c3d4-e5f6-7890-abcd-ef1234567890/reviewer-pool/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_reviewer_pool_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = proposal_protected_calls_reviewer_pool_list.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

for item in response:
    print(item)
  1. API Source: proposal_protected_calls_reviewer_pool_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { proposalProtectedCallsReviewerPoolList } from 'waldur-js-client';

try {
  const response = await proposalProtectedCallsReviewerPoolList({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
call string (uri)
call_uuid string (uuid)
call_name string
reviewer string (uri)
reviewer_uuid string Get reviewer profile UUID if available.
reviewer_name string Get reviewer name from profile or invited_user.
reviewer_email string Get email from profile, invited_user, or invited_email.
has_profile boolean Check if reviewer has a profile.
invited_email string (email) Email address for direct invitations
invited_user string (uri) Waldur user if email matches existing account
invited_user_name string
invited_at string (date-time)
invitation_status any
invitation_status_display string
response_date string (date-time)
decline_reason string
max_assignments integer
current_assignments integer
expertise_match_score number (double) Calculated affinity to call topics (0-1)
invited_by_name string
invitation_token string
invitation_expires_at string (date-time)
created string (date-time)
coi_count integer Count total COIs for this reviewer in this call.
coi_by_severity object (free-form) Count COIs by severity level.
reviews_pending integer Legacy field - always returns 0. Previously counted reviews in 'created' state, but that state has been removed. Reviews are now created directly in 'in_review' state. Kept for backwards compatibility with frontend.
reviews_in_progress integer Count reviews in 'in_review' state.
reviews_completed integer Count reviews in 'submitted' state.

List rounds for a call

List rounds for a call.

1
2
3
4
http \
  GET \
  https://api.example.com/api/proposal-protected-calls/a1b2c3d4-e5f6-7890-abcd-ef1234567890/rounds/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_rounds_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = proposal_protected_calls_rounds_list.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

for item in response:
    print(item)
  1. API Source: proposal_protected_calls_rounds_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { proposalProtectedCallsRoundsList } from 'waldur-js-client';

try {
  const response = await proposalProtectedCallsRoundsList({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid)
slug string
name string
start_time string (date-time)
cutoff_time string (date-time)
status any
review_strategy string
Enum: after_round, after_proposal
deciding_entity string
Enum: by_call_manager, automatic
allocation_time string
Enum: on_decision, fixed_date
allocation_date string (date-time)
minimal_average_scoring string (decimal)
review_duration_in_days integer
minimum_number_of_reviewers integer
url string
proposals array of objects
proposals.uuid string (uuid)
proposals.slug string
proposals.name string
proposals.state any
proposals.reviews array of anys Return serialized reviews based on user permissions and visibility settings. - Staff, call managers, and reviewers see all reviews. - Submitters see submitted reviews if visibility is enabled.
proposals.approved_by_name string
proposals.created_by_name string
proposals.created string (date-time)

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/proposal-protected-calls/string-value/rounds/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_rounds_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = proposal_protected_calls_rounds_retrieve.sync(
    obj_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    uuid="string-value",
    client=client
)

print(response)
  1. API Source: proposal_protected_calls_rounds_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { proposalProtectedCallsRoundsRetrieve } from 'waldur-js-client';

try {
  const response = await proposalProtectedCallsRoundsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "obj_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "uuid": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
obj_uuid string ✓
uuid string ✓

200 -

Field Type Description
uuid string (uuid)
slug string
name string
start_time string (date-time)
cutoff_time string (date-time)
status any
review_strategy string
Enum: after_round, after_proposal
deciding_entity string
Enum: by_call_manager, automatic
allocation_time string
Enum: on_decision, fixed_date
allocation_date string (date-time)
minimal_average_scoring string (decimal)
review_duration_in_days integer
minimum_number_of_reviewers integer
url string
proposals array of objects
proposals.uuid string (uuid)
proposals.slug string
proposals.name string
proposals.state any
proposals.reviews array of anys Return serialized reviews based on user permissions and visibility settings. - Staff, call managers, and reviewers see all reviews. - Submitters see submitted reviews if visibility is enabled.
proposals.approved_by_name string
proposals.created_by_name string
proposals.created string (date-time)

List all reviewer suggestions for this call with affinity scores

List all reviewer suggestions for this call with affinity scores.

1
2
3
4
http \
  GET \
  https://api.example.com/api/proposal-protected-calls/a1b2c3d4-e5f6-7890-abcd-ef1234567890/suggestions/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.call_states import CallStates # (1)
from waldur_api_client.models.protected_call_o_enum import ProtectedCallOEnum # (2)
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_suggestions_list # (3)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = proposal_protected_calls_suggestions_list.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

for item in response:
    print(item)
  1. Model Source: CallStates
  2. Model Source: ProtectedCallOEnum
  3. API Source: proposal_protected_calls_suggestions_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { proposalProtectedCallsSuggestionsList } from 'waldur-js-client';

try {
  const response = await proposalProtectedCallsSuggestionsList({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type Description
customer string (uri)
customer_keyword string
customer_uuid string (uuid)
has_active_round boolean
name string
o array Ordering
offering_uuid string (uuid)
offerings_provider_uuid string (uuid)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
state array

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
call string (uri)
call_uuid string (uuid)
call_name string
reviewer string (uri)
reviewer_uuid string (uuid)
reviewer_name string
reviewer_email string (email)
reviewer_biography string Professional biography / summary
affinity_score number (double) Combined affinity score (0-1)
keyword_score number (double) Keyword matching score
text_score number (double) TF-IDF text similarity score
status string
Enum: pending, confirmed, rejected, invited
status_display string
reviewed_by string (uri)
reviewed_by_name string
reviewed_at string (date-time)
rejection_reason string
matched_keywords any Keywords from reviewer's expertise that matched the source text
top_matching_proposals any Top proposals with highest affinity: [{uuid, name, slug, affinity}, ...]
source_type any What content was used to generate this suggestion
source_type_display string
created string (date-time)

Activate a call

Activate a call.

1
2
3
4
http \
  POST \
  https://api.example.com/api/proposal-protected-calls/a1b2c3d4-e5f6-7890-abcd-ef1234567890/activate/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_activate # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = proposal_protected_calls_activate.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: proposal_protected_calls_activate
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { proposalProtectedCallsActivate } from 'waldur-js-client';

try {
  const response = await proposalProtectedCallsActivate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
message string

Archive a call

Archive a call.

1
2
3
4
http \
  POST \
  https://api.example.com/api/proposal-protected-calls/a1b2c3d4-e5f6-7890-abcd-ef1234567890/archive/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_archive # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = proposal_protected_calls_archive.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: proposal_protected_calls_archive
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { proposalProtectedCallsArchive } from 'waldur-js-client';

try {
  const response = await proposalProtectedCallsArchive({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
message string

Attach documents to call

Attach documents to call.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/proposal-protected-calls/a1b2c3d4-e5f6-7890-abcd-ef1234567890/attach_documents/ \
  Authorization:"Token YOUR_API_TOKEN" \
  documents:='[]'

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.call_attach_documents_request import CallAttachDocumentsRequest # (1)
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_attach_documents # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = CallAttachDocumentsRequest(
    documents=[]
)
response = proposal_protected_calls_attach_documents.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: CallAttachDocumentsRequest
  2. API Source: proposal_protected_calls_attach_documents
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { proposalProtectedCallsAttachDocuments } from 'waldur-js-client';

try {
  const response = await proposalProtectedCallsAttachDocuments({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "documents": []
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
documents array of string (binary)s ✓
description string

200 - No response body

Compute affinity scores for all reviewer-proposal pairs

Compute affinity scores for all reviewer-proposal pairs.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/proposal-protected-calls/a1b2c3d4-e5f6-7890-abcd-ef1234567890/compute-affinities/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-proposal-protected-call" \
  manager="https://api.example.com/api/manager/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.protected_call_request import ProtectedCallRequest # (1)
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_compute_affinities # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ProtectedCallRequest(
    name="my-awesome-proposal-protected-call",
    manager="https://api.example.com/api/manager/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = proposal_protected_calls_compute_affinities.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ProtectedCallRequest
  2. API Source: proposal_protected_calls_compute_affinities
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { proposalProtectedCallsComputeAffinities } from 'waldur-js-client';

try {
  const response = await proposalProtectedCallsComputeAffinities({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-proposal-protected-call",
    "manager": "https://api.example.com/api/manager/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
slug string URL-friendly identifier. Only editable by staff users.
name string ✓
description string
manager string (uri) ✓
fixed_duration_in_days integer
backend_id string
external_url string (uri)
reviewer_identity_visible_to_submitters boolean Whether proposal applicants can see reviewer identities
reviews_visible_to_submitters boolean Whether proposal applicants can see review comments and scores
created_by string (uri)
reference_code string
compliance_checklist string (uuid) Compliance checklist that proposals must complete before submission
proposal_slug_template string Template for proposal slugs. Supports: {call_slug}, {round_slug}, {org_slug}, {year}, {month}, {counter}, {counter_padded}. Default: {round_slug}-{counter_padded}
user_email_patterns any List of email regex patterns. User must match one.
user_affiliations any List of allowed affiliations. User must have one.
user_identity_sources any List of allowed identity sources (identity providers).
user_nationalities any List of allowed nationality codes (ISO 3166-1 alpha-2). User must have one.
user_organization_types any List of allowed organization type URNs (SCHAC). User must match one.
user_assurance_levels any List of required assurance URIs (REFEDS). User must have ALL of these.

200 -

Field Type
computed_count integer
message string

Detach documents from call

Detach documents from call.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/proposal-protected-calls/a1b2c3d4-e5f6-7890-abcd-ef1234567890/detach_documents/ \
  Authorization:"Token YOUR_API_TOKEN" \
  documents:='[]'

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.call_detach_documents_request import CallDetachDocumentsRequest # (1)
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_detach_documents # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = CallDetachDocumentsRequest(
    documents=[]
)
response = proposal_protected_calls_detach_documents.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: CallDetachDocumentsRequest
  2. API Source: proposal_protected_calls_detach_documents
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { proposalProtectedCallsDetachDocuments } from 'waldur-js-client';

try {
  const response = await proposalProtectedCallsDetachDocuments({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "documents": []
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
documents array of string (uuid)s ✓

200 - No response body

Trigger automated COI detection for all reviewer-proposal pairs

Trigger automated COI detection for all reviewer-proposal pairs.

1
2
3
4
http \
  POST \
  https://api.example.com/api/proposal-protected-calls/a1b2c3d4-e5f6-7890-abcd-ef1234567890/detect-conflicts/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.trigger_coi_detection_request import TriggerCOIDetectionRequest # (1)
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_detect_conflicts # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = TriggerCOIDetectionRequest()
response = proposal_protected_calls_detect_conflicts.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: TriggerCOIDetectionRequest
  2. API Source: proposal_protected_calls_detect_conflicts
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { proposalProtectedCallsDetectConflicts } from 'waldur-js-client';

try {
  const response = await proposalProtectedCallsDetectConflicts({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
job_type any

200 -

Field Type Description
url string Return URL for the job detail endpoint.
uuid string (uuid)
call string (uri)
call_uuid string (uuid)
call_name string
job_type any
state any
total_pairs integer
processed_pairs integer
progress_percentage number (double)
conflicts_found integer
started_at string (date-time)
completed_at string (date-time)
error_message string
created string (date-time)

Generate assignments

Generate assignment batches for reviewers. Uses the affinity matrix and COI records to assign reviewers to proposals.

1
2
3
4
http \
  POST \
  https://api.example.com/api/proposal-protected-calls/a1b2c3d4-e5f6-7890-abcd-ef1234567890/generate-assignments/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.generate_assignments_request import GenerateAssignmentsRequest # (1)
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_generate_assignments # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = GenerateAssignmentsRequest()
response = proposal_protected_calls_generate_assignments.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: GenerateAssignmentsRequest
  2. API Source: proposal_protected_calls_generate_assignments
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { proposalProtectedCallsGenerateAssignments } from 'waldur-js-client';

try {
  const response = await proposalProtectedCallsGenerateAssignments({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
proposal_uuids array of string (uuid)s Specific proposal UUIDs to generate assignments for. If empty, generates for all submitted proposals needing reviewers.
reviewers_per_proposal integer Number of reviewers to assign per proposal. If not specified, uses call's minimum_number_of_reviewers setting.

200 -

Field Type Description
batches_created integer
items_created integer
proposals_processed integer
skipped_proposals array of objects Proposals that were skipped with reasons

Generate reviewer suggestions with configurable matching source

Generate reviewer suggestions with configurable matching source.

1
2
3
4
http \
  POST \
  https://api.example.com/api/proposal-protected-calls/a1b2c3d4-e5f6-7890-abcd-ef1234567890/generate-suggestions/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.generate_suggestions_request_request import GenerateSuggestionsRequestRequest # (1)
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_generate_suggestions # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = GenerateSuggestionsRequestRequest()
response = proposal_protected_calls_generate_suggestions.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: GenerateSuggestionsRequestRequest
  2. API Source: proposal_protected_calls_generate_suggestions
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { proposalProtectedCallsGenerateSuggestions } from 'waldur-js-client';

try {
  const response = await proposalProtectedCallsGenerateSuggestions({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
source any What content to match reviewers against
Constraints: default: all_proposals
proposal_uuids array of string (uuid)s Specific proposal UUIDs to match against (for selected_proposals source)
keywords array of strings Custom keywords to search for (for custom_keywords source)
keyword_search_mode any How to search for custom keywords
Constraints: default: expertise_only
min_affinity_threshold number (double) Minimum affinity score for suggestions (0.0-1.0)

200 -

Field Type
suggestions_created integer
reviewers_evaluated integer
source_used string
suggestions array of strings

Invite by email

Invite a reviewer by email address. Creates an invitation that requires the reviewer to create and publish a profile before accepting.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/proposal-protected-calls/a1b2c3d4-e5f6-7890-abcd-ef1234567890/invite-by-email/ \
  Authorization:"Token YOUR_API_TOKEN" \
  email="alice@example.com"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.email_invitation_request import EmailInvitationRequest # (1)
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_invite_by_email # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = EmailInvitationRequest(
    email="alice@example.com"
)
response = proposal_protected_calls_invite_by_email.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: EmailInvitationRequest
  2. API Source: proposal_protected_calls_invite_by_email
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { proposalProtectedCallsInviteByEmail } from 'waldur-js-client';

try {
  const response = await proposalProtectedCallsInviteByEmail({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "email": "alice@example.com"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
email string (email) ✓ Email address to send the invitation to
invitation_message string Custom message to include in invitation email
max_assignments integer
Constraints: default: 5

200 -

Field Type Description
url string (uri)
uuid string (uuid)
call string (uri)
call_uuid string (uuid)
call_name string
reviewer string (uri)
reviewer_uuid string Get reviewer profile UUID if available.
reviewer_name string Get reviewer name from profile or invited_user.
reviewer_email string Get email from profile, invited_user, or invited_email.
has_profile boolean Check if reviewer has a profile.
invited_email string (email) Email address for direct invitations
invited_user string (uri) Waldur user if email matches existing account
invited_user_name string
invited_at string (date-time)
invitation_status any
invitation_status_display string
response_date string (date-time)
decline_reason string
max_assignments integer
current_assignments integer
expertise_match_score number (double) Calculated affinity to call topics (0-1)
invited_by_name string
invitation_token string
invitation_expires_at string (date-time)
created string (date-time)
coi_count integer Count total COIs for this reviewer in this call.
coi_by_severity object (free-form) Count COIs by severity level.
reviews_pending integer Legacy field - always returns 0. Previously counted reviews in 'created' state, but that state has been removed. Reviews are now created directly in 'in_review' state. Kept for backwards compatibility with frontend.
reviews_in_progress integer Count reviews in 'in_review' state.
reviews_completed integer Count reviews in 'submitted' state.

Invite reviewers to join the call's reviewer pool

Invite reviewers to join the call's reviewer pool.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/proposal-protected-calls/a1b2c3d4-e5f6-7890-abcd-ef1234567890/reviewer-pool/ \
  Authorization:"Token YOUR_API_TOKEN" \
  reviewer_uuids:='[]'

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.call_states import CallStates # (1)
from waldur_api_client.models.protected_call_o_enum import ProtectedCallOEnum # (2)
from waldur_api_client.models.reviewer_invitation_request import ReviewerInvitationRequest # (3)
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_invite_reviewers # (4)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ReviewerInvitationRequest(
    reviewer_uuids=[]
)
response = proposal_protected_calls_invite_reviewers.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

for item in response:
    print(item)
  1. Model Source: CallStates
  2. Model Source: ProtectedCallOEnum
  3. Model Source: ReviewerInvitationRequest
  4. API Source: proposal_protected_calls_invite_reviewers
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { proposalProtectedCallsInviteReviewers } from 'waldur-js-client';

try {
  const response = await proposalProtectedCallsInviteReviewers({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "reviewer_uuids": []
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type Description
customer string (uri)
customer_keyword string
customer_uuid string (uuid)
has_active_round boolean
name string
o array Ordering
offering_uuid string (uuid)
offerings_provider_uuid string (uuid)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
state array
Field Type Required Description
reviewer_uuids array of string (uuid)s ✓ List of reviewer profile UUIDs to invite
max_assignments integer
Constraints: default: 5
invitation_message string Custom message to include in invitation email

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
call string (uri)
call_uuid string (uuid)
call_name string
reviewer string (uri)
reviewer_uuid string Get reviewer profile UUID if available.
reviewer_name string Get reviewer name from profile or invited_user.
reviewer_email string Get email from profile, invited_user, or invited_email.
has_profile boolean Check if reviewer has a profile.
invited_email string (email) Email address for direct invitations
invited_user string (uri) Waldur user if email matches existing account
invited_user_name string
invited_at string (date-time)
invitation_status any
invitation_status_display string
response_date string (date-time)
decline_reason string
max_assignments integer
current_assignments integer
expertise_match_score number (double) Calculated affinity to call topics (0-1)
invited_by_name string
invitation_token string
invitation_expires_at string (date-time)
created string (date-time)
coi_count integer Count total COIs for this reviewer in this call.
coi_by_severity object (free-form) Count COIs by severity level.
reviews_pending integer Legacy field - always returns 0. Previously counted reviews in 'created' state, but that state has been removed. Reviews are now created directly in 'in_review' state. Kept for backwards compatibility with frontend.
reviews_in_progress integer Count reviews in 'in_review' state.
reviews_completed integer Count reviews in 'submitted' state.

Create offering for a call

Create offering for a call.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/proposal-protected-calls/a1b2c3d4-e5f6-7890-abcd-ef1234567890/offerings/ \
  Authorization:"Token YOUR_API_TOKEN" \
  offering="https://api.example.com/api/offering/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.requested_offering_request import RequestedOfferingRequest # (1)
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_offerings_set # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = RequestedOfferingRequest(
    offering="https://api.example.com/api/offering/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = proposal_protected_calls_offerings_set.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: RequestedOfferingRequest
  2. API Source: proposal_protected_calls_offerings_set
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { proposalProtectedCallsOfferingsSet } from 'waldur-js-client';

try {
  const response = await proposalProtectedCallsOfferingsSet({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "offering": "https://api.example.com/api/offering/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
offering string (uri) ✓
attributes any
plan string (uri)
description string

200 -

Field Type Description
uuid string (uuid)
state any
offering string (uri)
offering_name string
offering_uuid string (uuid)
provider_name string
category_uuid string (uuid)
category_name string
call_managing_organisation string
attributes any
plan string (uri)
plan_details any
options any
components array of objects
components.uuid string (uuid)
components.billing_type string
Enum: fixed, usage, limit, one, few
components.type string Unique internal name of the measured unit, for example floating_ip.
components.name string Display name for the measured unit, for example, Floating IP.
components.description string
components.measured_unit string Unit of measurement, for example, GB.
components.unit_factor integer The conversion factor from backend units to measured_unit
components.limit_period any
components.limit_amount integer
components.article_code string
components.max_value integer
components.min_value integer
components.max_available_limit integer
components.is_boolean boolean
components.default_limit integer
components.factor integer
components.is_builtin boolean
components.is_prepaid boolean
components.overage_component string (uuid)
components.min_prepaid_duration integer
components.max_prepaid_duration integer
created string (date-time)
url string
approved_by string (uri)
created_by string (uri)
created_by_name string
approved_by_name string
description string

Create resource template for a call

Create resource template for a call.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/proposal-protected-calls/a1b2c3d4-e5f6-7890-abcd-ef1234567890/resource_templates/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-proposal-protected-call" \
  requested_offering="https://api.example.com/api/requested-offering/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.call_resource_template_request import CallResourceTemplateRequest # (1)
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_resource_templates_set # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = CallResourceTemplateRequest(
    name="my-awesome-proposal-protected-call",
    requested_offering="https://api.example.com/api/requested-offering/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = proposal_protected_calls_resource_templates_set.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: CallResourceTemplateRequest
  2. API Source: proposal_protected_calls_resource_templates_set
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { proposalProtectedCallsResourceTemplatesSet } from 'waldur-js-client';

try {
  const response = await proposalProtectedCallsResourceTemplatesSet({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-proposal-protected-call",
    "requested_offering": "https://api.example.com/api/requested-offering/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
name string ✓
description string
attributes any
limits any
is_required boolean If True, every proposal must include this resource type
requested_offering string (uri) ✓

200 -

Field Type Description
uuid string (uuid)
url string
name string
description string
attributes any
limits any
is_required boolean If True, every proposal must include this resource type
requested_offering string (uri)
requested_offering_name string
requested_offering_uuid string (uuid)
requested_offering_plan any
created_by string (uri)
created_by_name string
created string (date-time)

Mark proposal compliance as reviewed by call manager

Mark proposal compliance as reviewed by call manager.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/proposal-protected-calls/a1b2c3d4-e5f6-7890-abcd-ef1234567890/review_proposal_compliance/ \
  Authorization:"Token YOUR_API_TOKEN" \
  proposal_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.call_compliance_review_request import CallComplianceReviewRequest # (1)
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_review_proposal_compliance # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = CallComplianceReviewRequest(
    proposal_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
)
response = proposal_protected_calls_review_proposal_compliance.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: CallComplianceReviewRequest
  2. API Source: proposal_protected_calls_review_proposal_compliance
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { proposalProtectedCallsReviewProposalCompliance } from 'waldur-js-client';

try {
  const response = await proposalProtectedCallsReviewProposalCompliance({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "proposal_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
proposal_uuid string (uuid) ✓
review_notes string

200 -

Close

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/proposal-protected-calls/string-value/rounds/a1b2c3d4-e5f6-7890-abcd-ef1234567890/close/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-proposal-protected-call" \
  manager="https://api.example.com/api/manager/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.protected_call_request import ProtectedCallRequest # (1)
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_rounds_close # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ProtectedCallRequest(
    name="my-awesome-proposal-protected-call",
    manager="https://api.example.com/api/manager/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = proposal_protected_calls_rounds_close.sync(
    obj_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    uuid="string-value",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ProtectedCallRequest
  2. API Source: proposal_protected_calls_rounds_close
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
import { proposalProtectedCallsRoundsClose } from 'waldur-js-client';

try {
  const response = await proposalProtectedCallsRoundsClose({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "obj_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "uuid": "string-value"
  },
  body: {
    "name": "my-awesome-proposal-protected-call",
    "manager": "https://api.example.com/api/manager/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
obj_uuid string ✓
uuid string ✓
Field Type Required Description
slug string URL-friendly identifier. Only editable by staff users.
name string ✓
description string
manager string (uri) ✓
fixed_duration_in_days integer
backend_id string
external_url string (uri)
reviewer_identity_visible_to_submitters boolean Whether proposal applicants can see reviewer identities
reviews_visible_to_submitters boolean Whether proposal applicants can see review comments and scores
created_by string (uri)
reference_code string
compliance_checklist string (uuid) Compliance checklist that proposals must complete before submission
proposal_slug_template string Template for proposal slugs. Supports: {call_slug}, {round_slug}, {org_slug}, {year}, {month}, {counter}, {counter_padded}. Default: {round_slug}-{counter_padded}
user_email_patterns any List of email regex patterns. User must match one.
user_affiliations any List of allowed affiliations. User must have one.
user_identity_sources any List of allowed identity sources (identity providers).
user_nationalities any List of allowed nationality codes (ISO 3166-1 alpha-2). User must have one.
user_organization_types any List of allowed organization type URNs (SCHAC). User must match one.
user_assurance_levels any List of required assurance URIs (REFEDS). User must have ALL of these.

200 -

Field Type Description
url string (uri)
uuid string (uuid)
created string (date-time)
start_date string (date-time)
end_date string (date-time)
slug string URL-friendly identifier. Only editable by staff users.
name string
description string
state any
manager string (uri)
manager_uuid string (uuid)
customer_name string
customer_uuid string (uuid)
offerings array of objects
offerings.uuid string (uuid)
offerings.state any
offerings.offering string (uri)
offerings.offering_name string
offerings.offering_uuid string (uuid)
offerings.provider_name string
offerings.category_uuid string (uuid)
offerings.category_name string
offerings.call_managing_organisation string
offerings.attributes any
offerings.plan string (uri)
offerings.plan_details any
offerings.options any
offerings.components array of objects
offerings.components.uuid string (uuid)
offerings.components.billing_type string
Enum: fixed, usage, limit, one, few
offerings.components.type string Unique internal name of the measured unit, for example floating_ip.
offerings.components.name string Display name for the measured unit, for example, Floating IP.
offerings.components.description string
offerings.components.measured_unit string Unit of measurement, for example, GB.
offerings.components.unit_factor integer The conversion factor from backend units to measured_unit
offerings.components.limit_period any
offerings.components.limit_amount integer
offerings.components.article_code string
offerings.components.max_value integer
offerings.components.min_value integer
offerings.components.max_available_limit integer
offerings.components.is_boolean boolean
offerings.components.default_limit integer
offerings.components.factor integer
offerings.components.is_builtin boolean
offerings.components.is_prepaid boolean
offerings.components.overage_component string (uuid)
offerings.components.min_prepaid_duration integer
offerings.components.max_prepaid_duration integer
offerings.created string (date-time)
rounds array of objects
rounds.uuid string (uuid)
rounds.slug string
rounds.name string
rounds.start_time string (date-time)
rounds.cutoff_time string (date-time)
rounds.status any
rounds.review_strategy string
Enum: after_round, after_proposal
rounds.deciding_entity string
Enum: by_call_manager, automatic
rounds.allocation_time string
Enum: on_decision, fixed_date
rounds.allocation_date string (date-time)
rounds.minimal_average_scoring string (decimal)
rounds.review_duration_in_days integer
rounds.minimum_number_of_reviewers integer
documents array of objects
documents.uuid string (uuid)
documents.file string (uri) Documentation for call for proposals.
documents.file_name string
documents.file_size integer
documents.description string
documents.created string (date-time)
resource_templates array of objects
resource_templates.uuid string (uuid)
resource_templates.url string
resource_templates.name string
resource_templates.description string
resource_templates.attributes any
resource_templates.limits any
resource_templates.is_required boolean If True, every proposal must include this resource type
resource_templates.requested_offering string (uri)
resource_templates.requested_offering_name string
resource_templates.requested_offering_uuid string (uuid)
resource_templates.requested_offering_plan any
resource_templates.created_by string (uri)
resource_templates.created_by_name string
resource_templates.created string (date-time)
fixed_duration_in_days integer
backend_id string
external_url string (uri)
reviewer_identity_visible_to_submitters boolean Whether proposal applicants can see reviewer identities
reviews_visible_to_submitters boolean Whether proposal applicants can see review comments and scores
has_eligibility_restrictions boolean Check if call has any eligibility restrictions configured.
created_by string (uri)
reference_code string
compliance_checklist string (uuid) Compliance checklist that proposals must complete before submission
compliance_checklist_name string
proposal_slug_template string Template for proposal slugs. Supports: {call_slug}, {round_slug}, {org_slug}, {year}, {month}, {counter}, {counter_padded}. Default: {round_slug}-{counter_padded}
user_email_patterns any List of email regex patterns. User must match one.
user_affiliations any List of allowed affiliations. User must have one.
user_identity_sources any List of allowed identity sources (identity providers).
user_nationalities any List of allowed nationality codes (ISO 3166-1 alpha-2). User must have one.
user_organization_types any List of allowed organization type URNs (SCHAC). User must match one.
user_assurance_levels any List of required assurance URIs (REFEDS). User must have ALL of these.

Create a round for a call

Create a round for a call.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/proposal-protected-calls/a1b2c3d4-e5f6-7890-abcd-ef1234567890/rounds/ \
  Authorization:"Token YOUR_API_TOKEN" \
  start_time="2023-10-01T12:00:00Z" \
  cutoff_time="2023-10-01T12:00:00Z"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.protected_round_request import ProtectedRoundRequest # (1)
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_rounds_set # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ProtectedRoundRequest(
    start_time="2023-10-01T12:00:00Z",
    cutoff_time="2023-10-01T12:00:00Z"
)
response = proposal_protected_calls_rounds_set.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ProtectedRoundRequest
  2. API Source: proposal_protected_calls_rounds_set
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { proposalProtectedCallsRoundsSet } from 'waldur-js-client';

try {
  const response = await proposalProtectedCallsRoundsSet({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "start_time": "2023-10-01T12:00:00Z",
    "cutoff_time": "2023-10-01T12:00:00Z"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
start_time string (date-time) ✓
cutoff_time string (date-time) ✓
review_strategy string
deciding_entity string
allocation_time string
allocation_date string (date-time)
minimal_average_scoring string (decimal)
review_duration_in_days integer
minimum_number_of_reviewers integer

200 -

Field Type Description
uuid string (uuid)
slug string
name string
start_time string (date-time)
cutoff_time string (date-time)
status any
review_strategy string
Enum: after_round, after_proposal
deciding_entity string
Enum: by_call_manager, automatic
allocation_time string
Enum: on_decision, fixed_date
allocation_date string (date-time)
minimal_average_scoring string (decimal)
review_duration_in_days integer
minimum_number_of_reviewers integer
url string
proposals array of objects
proposals.uuid string (uuid)
proposals.slug string
proposals.name string
proposals.state any
proposals.reviews array of anys Return serialized reviews based on user permissions and visibility settings. - Staff, call managers, and reviewers see all reviews. - Submitters see submitted reviews if visibility is enabled.
proposals.approved_by_name string
proposals.created_by_name string
proposals.created string (date-time)

Send all draft assignment batches for this call

Send all draft assignment batches for this call.

1
2
3
4
http \
  POST \
  https://api.example.com/api/proposal-protected-calls/a1b2c3d4-e5f6-7890-abcd-ef1234567890/send-all-assignments/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.send_all_assignment_batches_request import SendAllAssignmentBatchesRequest # (1)
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_send_all_assignments # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = SendAllAssignmentBatchesRequest()
response = proposal_protected_calls_send_all_assignments.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: SendAllAssignmentBatchesRequest
  2. API Source: proposal_protected_calls_send_all_assignments
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { proposalProtectedCallsSendAllAssignments } from 'waldur-js-client';

try {
  const response = await proposalProtectedCallsSendAllAssignments({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
batch_uuids array of string (uuid)s Specific batch UUIDs to send. If empty, sends all draft batches.

200 -

Field Type
batches_sent integer
skipped integer

Send invitations to all confirmed suggestions

Send invitations to all confirmed suggestions.

1
2
3
4
http \
  POST \
  https://api.example.com/api/proposal-protected-calls/a1b2c3d4-e5f6-7890-abcd-ef1234567890/send-invitations/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_send_invitations # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = proposal_protected_calls_send_invitations.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: proposal_protected_calls_send_invitations
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { proposalProtectedCallsSendInvitations } from 'waldur-js-client';

try {
  const response = await proposalProtectedCallsSendInvitations({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
invitations_sent integer

Update

1
2
3
4
5
http \
  PUT \
  https://api.example.com/api/proposal-protected-calls/string-value/offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  offering="https://api.example.com/api/offering/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.requested_offering_request import RequestedOfferingRequest # (1)
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_offerings_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = RequestedOfferingRequest(
    offering="https://api.example.com/api/offering/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = proposal_protected_calls_offerings_update.sync(
    obj_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    uuid="string-value",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: RequestedOfferingRequest
  2. API Source: proposal_protected_calls_offerings_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { proposalProtectedCallsOfferingsUpdate } from 'waldur-js-client';

try {
  const response = await proposalProtectedCallsOfferingsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "obj_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "uuid": "string-value"
  },
  body: {
    "offering": "https://api.example.com/api/offering/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
obj_uuid string ✓
uuid string ✓
Field Type Required
offering string (uri) ✓
attributes any
plan string (uri)
description string

200 -

Field Type Description
uuid string (uuid)
state any
offering string (uri)
offering_name string
offering_uuid string (uuid)
provider_name string
category_uuid string (uuid)
category_name string
call_managing_organisation string
attributes any
plan string (uri)
plan_details any
options any
components array of objects
components.uuid string (uuid)
components.billing_type string
Enum: fixed, usage, limit, one, few
components.type string Unique internal name of the measured unit, for example floating_ip.
components.name string Display name for the measured unit, for example, Floating IP.
components.description string
components.measured_unit string Unit of measurement, for example, GB.
components.unit_factor integer The conversion factor from backend units to measured_unit
components.limit_period any
components.limit_amount integer
components.article_code string
components.max_value integer
components.min_value integer
components.max_available_limit integer
components.is_boolean boolean
components.default_limit integer
components.factor integer
components.is_builtin boolean
components.is_prepaid boolean
components.overage_component string (uuid)
components.min_prepaid_duration integer
components.max_prepaid_duration integer
created string (date-time)
url string
approved_by string (uri)
created_by string (uri)
created_by_name string
approved_by_name string
description string

Update

1
2
3
4
5
6
http \
  PUT \
  https://api.example.com/api/proposal-protected-calls/string-value/resource_templates/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-proposal-protected-call" \
  requested_offering="https://api.example.com/api/requested-offering/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.call_resource_template_request import CallResourceTemplateRequest # (1)
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_resource_templates_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = CallResourceTemplateRequest(
    name="my-awesome-proposal-protected-call",
    requested_offering="https://api.example.com/api/requested-offering/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = proposal_protected_calls_resource_templates_update.sync(
    obj_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    uuid="string-value",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: CallResourceTemplateRequest
  2. API Source: proposal_protected_calls_resource_templates_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
import { proposalProtectedCallsResourceTemplatesUpdate } from 'waldur-js-client';

try {
  const response = await proposalProtectedCallsResourceTemplatesUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "obj_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "uuid": "string-value"
  },
  body: {
    "name": "my-awesome-proposal-protected-call",
    "requested_offering": "https://api.example.com/api/requested-offering/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
obj_uuid string ✓
uuid string ✓
Field Type Required Description
name string ✓
description string
attributes any
limits any
is_required boolean If True, every proposal must include this resource type
requested_offering string (uri) ✓

200 -

Field Type Description
uuid string (uuid)
url string
name string
description string
attributes any
limits any
is_required boolean If True, every proposal must include this resource type
requested_offering string (uri)
requested_offering_name string
requested_offering_uuid string (uuid)
requested_offering_plan any
created_by string (uri)
created_by_name string
created string (date-time)

Update

1
2
3
4
5
6
http \
  PUT \
  https://api.example.com/api/proposal-protected-calls/string-value/rounds/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  start_time="2023-10-01T12:00:00Z" \
  cutoff_time="2023-10-01T12:00:00Z"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.protected_round_request import ProtectedRoundRequest # (1)
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_rounds_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ProtectedRoundRequest(
    start_time="2023-10-01T12:00:00Z",
    cutoff_time="2023-10-01T12:00:00Z"
)
response = proposal_protected_calls_rounds_update.sync(
    obj_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    uuid="string-value",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ProtectedRoundRequest
  2. API Source: proposal_protected_calls_rounds_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
import { proposalProtectedCallsRoundsUpdate } from 'waldur-js-client';

try {
  const response = await proposalProtectedCallsRoundsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "obj_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "uuid": "string-value"
  },
  body: {
    "start_time": "2023-10-01T12:00:00Z",
    "cutoff_time": "2023-10-01T12:00:00Z"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
obj_uuid string ✓
uuid string ✓
Field Type Required
start_time string (date-time) ✓
cutoff_time string (date-time) ✓
review_strategy string
deciding_entity string
allocation_time string
allocation_date string (date-time)
minimal_average_scoring string (decimal)
review_duration_in_days integer
minimum_number_of_reviewers integer

200 -

Field Type Description
uuid string (uuid)
slug string
name string
start_time string (date-time)
cutoff_time string (date-time)
status any
review_strategy string
Enum: after_round, after_proposal
deciding_entity string
Enum: by_call_manager, automatic
allocation_time string
Enum: on_decision, fixed_date
allocation_date string (date-time)
minimal_average_scoring string (decimal)
review_duration_in_days integer
minimum_number_of_reviewers integer
url string
proposals array of objects
proposals.uuid string (uuid)
proposals.slug string
proposals.name string
proposals.state any
proposals.reviews array of anys Return serialized reviews based on user permissions and visibility settings. - Staff, call managers, and reviewers see all reviews. - Submitters see submitted reviews if visibility is enabled.
proposals.approved_by_name string
proposals.created_by_name string
proposals.created string (date-time)

Get COI configuration for this call

Get COI configuration for this call.

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/proposal-protected-calls/a1b2c3d4-e5f6-7890-abcd-ef1234567890/coi-configuration/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_call_coi_configuration_request import PatchedCallCOIConfigurationRequest # (1)
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_coi_configuration_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedCallCOIConfigurationRequest()
response = proposal_protected_calls_coi_configuration_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedCallCOIConfigurationRequest
  2. API Source: proposal_protected_calls_coi_configuration_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { proposalProtectedCallsCoiConfigurationPartialUpdate } from 'waldur-js-client';

try {
  const response = await proposalProtectedCallsCoiConfigurationPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
coauthorship_lookback_years integer Years to look back for co-authorship detection
coauthorship_threshold_papers integer Minimum shared papers to trigger COI
institutional_lookback_years integer Years to look back for former institution detection
include_same_department boolean Detect same-department as COI
include_same_institution boolean Detect same-institution as COI
recusal_required_types array of strings COI types requiring automatic recusal
management_allowed_types array of strings COI types allowing management plan
disclosure_only_types array of strings COI types requiring disclosure only
auto_detect_coauthorship boolean Enable automated co-authorship detection
auto_detect_institutional boolean Enable automated institutional affiliation detection
auto_detect_named_personnel boolean Enable detection of reviewer named in proposals
invitation_proposal_disclosure any Level of proposal information disclosed in reviewer invitations

200 -

Field Type Description
uuid string (uuid)
call string (uri)
call_uuid string (uuid)
call_name string
coauthorship_lookback_years integer Years to look back for co-authorship detection
coauthorship_threshold_papers integer Minimum shared papers to trigger COI
institutional_lookback_years integer Years to look back for former institution detection
include_same_department boolean Detect same-department as COI
include_same_institution boolean Detect same-institution as COI
recusal_required_types array of strings COI types requiring automatic recusal
management_allowed_types array of strings COI types allowing management plan
disclosure_only_types array of strings COI types requiring disclosure only
auto_detect_coauthorship boolean Enable automated co-authorship detection
auto_detect_institutional boolean Enable automated institutional affiliation detection
auto_detect_named_personnel boolean Enable detection of reviewer named in proposals
invitation_proposal_disclosure any Level of proposal information disclosed in reviewer invitations
created string (date-time)
modified string (date-time)

Get or update matching configuration for this call

Get or update matching configuration for this call.

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/proposal-protected-calls/a1b2c3d4-e5f6-7890-abcd-ef1234567890/matching-configuration/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_matching_configuration_request import PatchedMatchingConfigurationRequest # (1)
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_matching_configuration_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedMatchingConfigurationRequest()
response = proposal_protected_calls_matching_configuration_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedMatchingConfigurationRequest
  2. API Source: proposal_protected_calls_matching_configuration_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { proposalProtectedCallsMatchingConfigurationPartialUpdate } from 'waldur-js-client';

try {
  const response = await proposalProtectedCallsMatchingConfigurationPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
affinity_method string
Enum: keyword, tfidf, combined
keyword_weight number (double)
text_weight number (double)
min_reviewers_per_proposal integer
max_reviewers_per_proposal integer
min_proposals_per_reviewer integer
max_proposals_per_reviewer integer
algorithm string
Enum: minmax, fairflow, hungarian
min_affinity_threshold number (double) Minimum affinity score for FairFlow algorithm
use_reviewer_bids boolean
bid_weight number (double)

200 -

Field Type Description
uuid string (uuid)
call_uuid string (uuid)
call_name string
affinity_method string
Enum: keyword, tfidf, combined
keyword_weight number (double)
text_weight number (double)
min_reviewers_per_proposal integer
max_reviewers_per_proposal integer
min_proposals_per_reviewer integer
max_proposals_per_reviewer integer
algorithm string
Enum: minmax, fairflow, hungarian
min_affinity_threshold number (double) Minimum affinity score for FairFlow algorithm
use_reviewer_bids boolean
bid_weight number (double)
created string (date-time)
modified string (date-time)

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/proposal-protected-calls/string-value/offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_requested_offering_request import PatchedRequestedOfferingRequest # (1)
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_offerings_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedRequestedOfferingRequest()
response = proposal_protected_calls_offerings_partial_update.sync(
    obj_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    uuid="string-value",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedRequestedOfferingRequest
  2. API Source: proposal_protected_calls_offerings_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { proposalProtectedCallsOfferingsPartialUpdate } from 'waldur-js-client';

try {
  const response = await proposalProtectedCallsOfferingsPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "obj_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "uuid": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
obj_uuid string ✓
uuid string ✓
Field Type Required
attributes any
plan string (uri)
description string

200 -

Field Type Description
uuid string (uuid)
state any
offering string (uri)
offering_name string
offering_uuid string (uuid)
provider_name string
category_uuid string (uuid)
category_name string
call_managing_organisation string
attributes any
plan string (uri)
plan_details any
options any
components array of objects
components.uuid string (uuid)
components.billing_type string
Enum: fixed, usage, limit, one, few
components.type string Unique internal name of the measured unit, for example floating_ip.
components.name string Display name for the measured unit, for example, Floating IP.
components.description string
components.measured_unit string Unit of measurement, for example, GB.
components.unit_factor integer The conversion factor from backend units to measured_unit
components.limit_period any
components.limit_amount integer
components.article_code string
components.max_value integer
components.min_value integer
components.max_available_limit integer
components.is_boolean boolean
components.default_limit integer
components.factor integer
components.is_builtin boolean
components.is_prepaid boolean
components.overage_component string (uuid)
components.min_prepaid_duration integer
components.max_prepaid_duration integer
created string (date-time)
url string
approved_by string (uri)
created_by string (uri)
created_by_name string
approved_by_name string
description string

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/proposal-protected-calls/string-value/resource_templates/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_call_resource_template_request import PatchedCallResourceTemplateRequest # (1)
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_resource_templates_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedCallResourceTemplateRequest()
response = proposal_protected_calls_resource_templates_partial_update.sync(
    obj_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    uuid="string-value",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedCallResourceTemplateRequest
  2. API Source: proposal_protected_calls_resource_templates_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { proposalProtectedCallsResourceTemplatesPartialUpdate } from 'waldur-js-client';

try {
  const response = await proposalProtectedCallsResourceTemplatesPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "obj_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "uuid": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
obj_uuid string ✓
uuid string ✓
Field Type Required Description
name string
description string
attributes any
limits any
is_required boolean If True, every proposal must include this resource type
requested_offering string (uri)

200 -

Field Type Description
uuid string (uuid)
url string
name string
description string
attributes any
limits any
is_required boolean If True, every proposal must include this resource type
requested_offering string (uri)
requested_offering_name string
requested_offering_uuid string (uuid)
requested_offering_plan any
created_by string (uri)
created_by_name string
created string (date-time)

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/proposal-protected-calls/string-value/rounds/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_protected_round_request import PatchedProtectedRoundRequest # (1)
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_rounds_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedProtectedRoundRequest()
response = proposal_protected_calls_rounds_partial_update.sync(
    obj_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    uuid="string-value",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedProtectedRoundRequest
  2. API Source: proposal_protected_calls_rounds_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { proposalProtectedCallsRoundsPartialUpdate } from 'waldur-js-client';

try {
  const response = await proposalProtectedCallsRoundsPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "obj_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "uuid": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
obj_uuid string ✓
uuid string ✓
Field Type Required
start_time string (date-time)
cutoff_time string (date-time)
review_strategy string
deciding_entity string
allocation_time string
allocation_date string (date-time)
minimal_average_scoring string (decimal)
review_duration_in_days integer
minimum_number_of_reviewers integer

200 -

Field Type Description
uuid string (uuid)
slug string
name string
start_time string (date-time)
cutoff_time string (date-time)
status any
review_strategy string
Enum: after_round, after_proposal
deciding_entity string
Enum: by_call_manager, automatic
allocation_time string
Enum: on_decision, fixed_date
allocation_date string (date-time)
minimal_average_scoring string (decimal)
review_duration_in_days integer
minimum_number_of_reviewers integer
url string
proposals array of objects
proposals.uuid string (uuid)
proposals.slug string
proposals.name string
proposals.state any
proposals.reviews array of anys Return serialized reviews based on user permissions and visibility settings. - Staff, call managers, and reviewers see all reviews. - Submitters see submitted reviews if visibility is enabled.
proposals.approved_by_name string
proposals.created_by_name string
proposals.created string (date-time)

Delete custom applicant attribute config, reverting to system defaults

Delete custom applicant attribute config, reverting to system defaults.

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/proposal-protected-calls/a1b2c3d4-e5f6-7890-abcd-ef1234567890/delete_applicant_attribute_config/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_delete_applicant_attribute_config_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = proposal_protected_calls_delete_applicant_attribute_config_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: proposal_protected_calls_delete_applicant_attribute_config_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { proposalProtectedCallsDeleteApplicantAttributeConfigDestroy } from 'waldur-js-client';

try {
  const response = await proposalProtectedCallsDeleteApplicantAttributeConfigDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/proposal-protected-calls/string-value/offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_offerings_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = proposal_protected_calls_offerings_destroy.sync(
    obj_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    uuid="string-value",
    client=client
)

print(response)
  1. API Source: proposal_protected_calls_offerings_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { proposalProtectedCallsOfferingsDestroy } from 'waldur-js-client';

try {
  const response = await proposalProtectedCallsOfferingsDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "obj_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "uuid": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
obj_uuid string ✓
uuid string ✓

204 - No response body

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/proposal-protected-calls/string-value/resource_templates/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_resource_templates_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = proposal_protected_calls_resource_templates_destroy.sync(
    obj_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    uuid="string-value",
    client=client
)

print(response)
  1. API Source: proposal_protected_calls_resource_templates_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { proposalProtectedCallsResourceTemplatesDestroy } from 'waldur-js-client';

try {
  const response = await proposalProtectedCallsResourceTemplatesDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "obj_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "uuid": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
obj_uuid string ✓
uuid string ✓

204 - No response body

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/proposal-protected-calls/string-value/rounds/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.proposal_protected_calls import proposal_protected_calls_rounds_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = proposal_protected_calls_rounds_destroy.sync(
    obj_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    uuid="string-value",
    client=client
)

print(response)
  1. API Source: proposal_protected_calls_rounds_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { proposalProtectedCallsRoundsDestroy } from 'waldur-js-client';

try {
  const response = await proposalProtectedCallsRoundsDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "obj_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "uuid": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
obj_uuid string ✓
uuid string ✓

204 - No response body

Proposal Public Calls

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/proposal-public-calls/ List Proposal Public Calls
GET /api/proposal-public-calls/{uuid}/ Retrieve
Other Actions
GET /api/proposal-public-calls/{uuid}/check_eligibility/ Check if the current user is eligible to submit proposals to this call

Core CRUD

List Proposal Public Calls

1
2
3
4
http \
  GET \
  https://api.example.com/api/proposal-public-calls/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.call_states import CallStates # (1)
from waldur_api_client.models.protected_call_o_enum import ProtectedCallOEnum # (2)
from waldur_api_client.models.public_call_field_enum import PublicCallFieldEnum # (3)
from waldur_api_client.api.proposal_public_calls import proposal_public_calls_list # (4)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = proposal_public_calls_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: CallStates
  2. Model Source: ProtectedCallOEnum
  3. Model Source: PublicCallFieldEnum
  4. API Source: proposal_public_calls_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { proposalPublicCallsList } from 'waldur-js-client';

try {
  const response = await proposalPublicCallsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
customer string (uri)
customer_keyword string
customer_uuid string (uuid)
field array
has_active_round boolean
name string
o array Ordering
offering_uuid string (uuid)
offerings_provider_uuid string (uuid)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
state array

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
created string (date-time)
start_date string (date-time)
end_date string (date-time)
slug string URL-friendly identifier. Only editable by staff users.
name string
description string
state any
manager string (uri)
manager_uuid string (uuid)
customer_name string
customer_uuid string (uuid)
offerings array of objects
offerings.uuid string (uuid)
offerings.state any
offerings.offering string (uri)
offerings.offering_name string
offerings.offering_uuid string (uuid)
offerings.provider_name string
offerings.category_uuid string (uuid)
offerings.category_name string
offerings.call_managing_organisation string
offerings.attributes any
offerings.plan string (uri)
offerings.plan_details any
offerings.options any
offerings.components array of objects
offerings.components.uuid string (uuid)
offerings.components.billing_type string
Enum: fixed, usage, limit, one, few
offerings.components.type string Unique internal name of the measured unit, for example floating_ip.
offerings.components.name string Display name for the measured unit, for example, Floating IP.
offerings.components.description string
offerings.components.measured_unit string Unit of measurement, for example, GB.
offerings.components.unit_factor integer The conversion factor from backend units to measured_unit
offerings.components.limit_period any
offerings.components.limit_amount integer
offerings.components.article_code string
offerings.components.max_value integer
offerings.components.min_value integer
offerings.components.max_available_limit integer
offerings.components.is_boolean boolean
offerings.components.default_limit integer
offerings.components.factor integer
offerings.components.is_builtin boolean
offerings.components.is_prepaid boolean
offerings.components.overage_component string (uuid)
offerings.components.min_prepaid_duration integer
offerings.components.max_prepaid_duration integer
offerings.created string (date-time)
rounds array of objects
rounds.uuid string (uuid)
rounds.slug string
rounds.name string
rounds.start_time string (date-time)
rounds.cutoff_time string (date-time)
rounds.status any
rounds.review_strategy string
Enum: after_round, after_proposal
rounds.deciding_entity string
Enum: by_call_manager, automatic
rounds.allocation_time string
Enum: on_decision, fixed_date
rounds.allocation_date string (date-time)
rounds.minimal_average_scoring string (decimal)
rounds.review_duration_in_days integer
rounds.minimum_number_of_reviewers integer
documents array of objects
documents.uuid string (uuid)
documents.file string (uri) Documentation for call for proposals.
documents.file_name string
documents.file_size integer
documents.description string
documents.created string (date-time)
resource_templates array of objects
resource_templates.uuid string (uuid)
resource_templates.url string
resource_templates.name string
resource_templates.description string
resource_templates.attributes any
resource_templates.limits any
resource_templates.is_required boolean If True, every proposal must include this resource type
resource_templates.requested_offering string (uri)
resource_templates.requested_offering_name string
resource_templates.requested_offering_uuid string (uuid)
resource_templates.requested_offering_plan any
resource_templates.created_by string (uri)
resource_templates.created_by_name string
resource_templates.created string (date-time)
fixed_duration_in_days integer Fixed duration in days that applies to all proposals in this call
backend_id string
external_url string (uri)
reviewer_identity_visible_to_submitters boolean Whether proposal applicants can see reviewer identities. If False, reviewers appear as 'Reviewer 1', 'Reviewer 2', etc.
reviews_visible_to_submitters boolean Whether proposal applicants can see review comments and scores. If False, applicants only see final approval/rejection status.
has_eligibility_restrictions boolean Check if call has any eligibility restrictions configured.

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/proposal-public-calls/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.public_call_field_enum import PublicCallFieldEnum # (1)
from waldur_api_client.api.proposal_public_calls import proposal_public_calls_retrieve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = proposal_public_calls_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. Model Source: PublicCallFieldEnum
  2. API Source: proposal_public_calls_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { proposalPublicCallsRetrieve } from 'waldur-js-client';

try {
  const response = await proposalPublicCallsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type
field array

200 -

Field Type Description
url string (uri)
uuid string (uuid)
created string (date-time)
start_date string (date-time)
end_date string (date-time)
slug string URL-friendly identifier. Only editable by staff users.
name string
description string
state any
manager string (uri)
manager_uuid string (uuid)
customer_name string
customer_uuid string (uuid)
offerings array of objects
offerings.uuid string (uuid)
offerings.state any
offerings.offering string (uri)
offerings.offering_name string
offerings.offering_uuid string (uuid)
offerings.provider_name string
offerings.category_uuid string (uuid)
offerings.category_name string
offerings.call_managing_organisation string
offerings.attributes any
offerings.plan string (uri)
offerings.plan_details any
offerings.options any
offerings.components array of objects
offerings.components.uuid string (uuid)
offerings.components.billing_type string
Enum: fixed, usage, limit, one, few
offerings.components.type string Unique internal name of the measured unit, for example floating_ip.
offerings.components.name string Display name for the measured unit, for example, Floating IP.
offerings.components.description string
offerings.components.measured_unit string Unit of measurement, for example, GB.
offerings.components.unit_factor integer The conversion factor from backend units to measured_unit
offerings.components.limit_period any
offerings.components.limit_amount integer
offerings.components.article_code string
offerings.components.max_value integer
offerings.components.min_value integer
offerings.components.max_available_limit integer
offerings.components.is_boolean boolean
offerings.components.default_limit integer
offerings.components.factor integer
offerings.components.is_builtin boolean
offerings.components.is_prepaid boolean
offerings.components.overage_component string (uuid)
offerings.components.min_prepaid_duration integer
offerings.components.max_prepaid_duration integer
offerings.created string (date-time)
rounds array of objects
rounds.uuid string (uuid)
rounds.slug string
rounds.name string
rounds.start_time string (date-time)
rounds.cutoff_time string (date-time)
rounds.status any
rounds.review_strategy string
Enum: after_round, after_proposal
rounds.deciding_entity string
Enum: by_call_manager, automatic
rounds.allocation_time string
Enum: on_decision, fixed_date
rounds.allocation_date string (date-time)
rounds.minimal_average_scoring string (decimal)
rounds.review_duration_in_days integer
rounds.minimum_number_of_reviewers integer
documents array of objects
documents.uuid string (uuid)
documents.file string (uri) Documentation for call for proposals.
documents.file_name string
documents.file_size integer
documents.description string
documents.created string (date-time)
resource_templates array of objects
resource_templates.uuid string (uuid)
resource_templates.url string
resource_templates.name string
resource_templates.description string
resource_templates.attributes any
resource_templates.limits any
resource_templates.is_required boolean If True, every proposal must include this resource type
resource_templates.requested_offering string (uri)
resource_templates.requested_offering_name string
resource_templates.requested_offering_uuid string (uuid)
resource_templates.requested_offering_plan any
resource_templates.created_by string (uri)
resource_templates.created_by_name string
resource_templates.created string (date-time)
fixed_duration_in_days integer Fixed duration in days that applies to all proposals in this call
backend_id string
external_url string (uri)
reviewer_identity_visible_to_submitters boolean Whether proposal applicants can see reviewer identities. If False, reviewers appear as 'Reviewer 1', 'Reviewer 2', etc.
reviews_visible_to_submitters boolean Whether proposal applicants can see review comments and scores. If False, applicants only see final approval/rejection status.
has_eligibility_restrictions boolean Check if call has any eligibility restrictions configured.

Other Actions

Check if the current user is eligible to submit proposals to this call

Check if the current user is eligible to submit proposals to this call.

1
2
3
4
http \
  GET \
  https://api.example.com/api/proposal-public-calls/a1b2c3d4-e5f6-7890-abcd-ef1234567890/check_eligibility/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.proposal_public_calls import proposal_public_calls_check_eligibility_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = proposal_public_calls_check_eligibility_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: proposal_public_calls_check_eligibility_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { proposalPublicCallsCheckEligibilityRetrieve } from 'waldur-js-client';

try {
  const response = await proposalPublicCallsCheckEligibilityRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
is_eligible boolean
restrictions array of strings

Call Reviewer Pools

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/call-reviewer-pools/ List Call Reviewer Pools
GET /api/call-reviewer-pools/{uuid}/ Retrieve
PATCH /api/call-reviewer-pools/{uuid}/ Partial Update
Other Actions
POST /api/call-reviewer-pools/{uuid}/accept/ Accept a pool invitation (authenticated users only)
POST /api/call-reviewer-pools/{uuid}/decline/ Decline a pool invitation (authenticated users only)

Core CRUD

List Call Reviewer Pools

1
2
3
4
http \
  GET \
  https://api.example.com/api/call-reviewer-pools/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.call_reviewer_pool_o_enum import CallReviewerPoolOEnum # (1)
from waldur_api_client.models.invitation_status_enum import InvitationStatusEnum # (2)
from waldur_api_client.api.call_reviewer_pools import call_reviewer_pools_list # (3)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = call_reviewer_pools_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: CallReviewerPoolOEnum
  2. Model Source: InvitationStatusEnum
  3. API Source: call_reviewer_pools_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { callReviewerPoolsList } from 'waldur-js-client';

try {
  const response = await callReviewerPoolsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
call_uuid string (uuid)
invitation_status array
my_invitations boolean
o array Ordering
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
reviewer_uuid string (uuid)

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
call string (uri)
call_uuid string (uuid)
call_name string
reviewer string (uri)
reviewer_uuid string Get reviewer profile UUID if available.
reviewer_name string Get reviewer name from profile or invited_user.
reviewer_email string Get email from profile, invited_user, or invited_email.
has_profile boolean Check if reviewer has a profile.
invited_email string (email) Email address for direct invitations
invited_user string (uri) Waldur user if email matches existing account
invited_user_name string
invited_at string (date-time)
invitation_status any
invitation_status_display string
response_date string (date-time)
decline_reason string
max_assignments integer
current_assignments integer
expertise_match_score number (double) Calculated affinity to call topics (0-1)
invited_by_name string
invitation_token string
invitation_expires_at string (date-time)
created string (date-time)
coi_count integer Count total COIs for this reviewer in this call.
coi_by_severity object (free-form) Count COIs by severity level.
reviews_pending integer Legacy field - always returns 0. Previously counted reviews in 'created' state, but that state has been removed. Reviews are now created directly in 'in_review' state. Kept for backwards compatibility with frontend.
reviews_in_progress integer Count reviews in 'in_review' state.
reviews_completed integer Count reviews in 'submitted' state.

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/call-reviewer-pools/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.call_reviewer_pools import call_reviewer_pools_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = call_reviewer_pools_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: call_reviewer_pools_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { callReviewerPoolsRetrieve } from 'waldur-js-client';

try {
  const response = await callReviewerPoolsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
url string (uri)
uuid string (uuid)
call string (uri)
call_uuid string (uuid)
call_name string
reviewer string (uri)
reviewer_uuid string Get reviewer profile UUID if available.
reviewer_name string Get reviewer name from profile or invited_user.
reviewer_email string Get email from profile, invited_user, or invited_email.
has_profile boolean Check if reviewer has a profile.
invited_email string (email) Email address for direct invitations
invited_user string (uri) Waldur user if email matches existing account
invited_user_name string
invited_at string (date-time)
invitation_status any
invitation_status_display string
response_date string (date-time)
decline_reason string
max_assignments integer
current_assignments integer
expertise_match_score number (double) Calculated affinity to call topics (0-1)
invited_by_name string
invitation_token string
invitation_expires_at string (date-time)
created string (date-time)
coi_count integer Count total COIs for this reviewer in this call.
coi_by_severity object (free-form) Count COIs by severity level.
reviews_pending integer Legacy field - always returns 0. Previously counted reviews in 'created' state, but that state has been removed. Reviews are now created directly in 'in_review' state. Kept for backwards compatibility with frontend.
reviews_in_progress integer Count reviews in 'in_review' state.
reviews_completed integer Count reviews in 'submitted' state.

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/call-reviewer-pools/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_call_reviewer_pool_update_request import PatchedCallReviewerPoolUpdateRequest # (1)
from waldur_api_client.api.call_reviewer_pools import call_reviewer_pools_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedCallReviewerPoolUpdateRequest()
response = call_reviewer_pools_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedCallReviewerPoolUpdateRequest
  2. API Source: call_reviewer_pools_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { callReviewerPoolsPartialUpdate } from 'waldur-js-client';

try {
  const response = await callReviewerPoolsPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
max_assignments integer Maximum number of proposals that can be assigned to this reviewer

200 -

Field Type Description
max_assignments integer Maximum number of proposals that can be assigned to this reviewer

Other Actions

Accept a pool invitation (authenticated users only)

Accept a pool invitation (authenticated users only).

1
2
3
4
echo '[{"proposal_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "coi_type": "INST_SAME", "severity": null, "description": "A sample description."}]' | http \
  POST \
  https://api.example.com/api/call-reviewer-pools/a1b2c3d4-e5f6-7890-abcd-ef1234567890/accept/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.call_reviewer_pools import call_reviewer_pools_accept # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = call_reviewer_pools_accept.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: call_reviewer_pools_accept
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { callReviewerPoolsAccept } from 'waldur-js-client';

try {
  const response = await callReviewerPoolsAccept({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: [{"proposal_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "coi_type": "INST_SAME", "severity": null, "description": "A sample description."}]
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

The request body is an array of objects, where each object has the following structure:

Field Type Required
proposal_uuid string (uuid) ✓
coi_type string ✓
severity any
description string

200 -

Field Type Description
detail string
declared_conflicts array of string (uuid)s UUIDs of created conflict records

400 -

Field Type
error string
message string
profile_url string

Decline a pool invitation (authenticated users only)

Decline a pool invitation (authenticated users only).

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/call-reviewer-pools/a1b2c3d4-e5f6-7890-abcd-ef1234567890/decline/ \
  Authorization:"Token YOUR_API_TOKEN" \
  reason="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.invitation_decline_request import InvitationDeclineRequest # (1)
from waldur_api_client.api.call_reviewer_pools import call_reviewer_pools_decline # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = InvitationDeclineRequest(
    reason="string-value"
)
response = call_reviewer_pools_decline.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: InvitationDeclineRequest
  2. API Source: call_reviewer_pools_decline
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { callReviewerPoolsDecline } from 'waldur-js-client';

try {
  const response = await callReviewerPoolsDecline({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "reason": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
reason string ✓ Reason for declining the invitation

200 -

Field Type
detail string

Call Rounds

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/call-rounds/ List Call Rounds
GET /api/call-rounds/{uuid}/ Retrieve
Other Actions
GET /api/call-rounds/{uuid}/reviewers/ Return list of reviewers for round

Core CRUD

List Call Rounds

1
2
3
4
http \
  GET \
  https://api.example.com/api/call-rounds/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.call_rounds import call_rounds_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = call_rounds_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: call_rounds_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { callRoundsList } from 'waldur-js-client';

try {
  const response = await callRoundsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
url string (uri)
uuid string (uuid)
slug string
start_time string (date-time)
cutoff_time string (date-time)
call_uuid string (uuid)
call_name string
status any

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/call-rounds/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.call_rounds import call_rounds_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = call_rounds_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: call_rounds_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { callRoundsRetrieve } from 'waldur-js-client';

try {
  const response = await callRoundsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
url string (uri)
uuid string (uuid)
slug string
start_time string (date-time)
cutoff_time string (date-time)
call_uuid string (uuid)
call_name string
status any

Other Actions

Return list of reviewers for round

Return list of reviewers for round.

1
2
3
4
http \
  GET \
  https://api.example.com/api/call-rounds/a1b2c3d4-e5f6-7890-abcd-ef1234567890/reviewers/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.call_rounds import call_rounds_reviewers_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = call_rounds_reviewers_list.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

for item in response:
    print(item)
  1. API Source: call_rounds_reviewers_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { callRoundsReviewersList } from 'waldur-js-client';

try {
  const response = await callRoundsReviewersList({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
full_name string
email string (email)
accepted_proposals integer
rejected_proposals integer
in_review_proposals integer

Proposals

Assignment Batches

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/assignment-batches/ List Assignment Batches
GET /api/assignment-batches/{uuid}/ Retrieve
POST /api/assignment-batches/ Create
PUT /api/assignment-batches/{uuid}/ Update
PATCH /api/assignment-batches/{uuid}/ Partial Update
DELETE /api/assignment-batches/{uuid}/ Delete
Other Actions
POST /api/assignment-batches/{uuid}/cancel/ Cancel this assignment batch
POST /api/assignment-batches/{uuid}/extend-deadline/ Extend deadline
POST /api/assignment-batches/{uuid}/send/ Send this assignment batch invitation to the reviewer

Core CRUD

List Assignment Batches

1
2
3
4
http \
  GET \
  https://api.example.com/api/assignment-batches/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.assignment_batch_list_o_enum import AssignmentBatchListOEnum # (1)
from waldur_api_client.models.assignment_batch_status import AssignmentBatchStatus # (2)
from waldur_api_client.models.assignment_source import AssignmentSource # (3)
from waldur_api_client.api.assignment_batches import assignment_batches_list # (4)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = assignment_batches_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: AssignmentBatchListOEnum
  2. Model Source: AssignmentBatchStatus
  3. Model Source: AssignmentSource
  4. API Source: assignment_batches_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { assignmentBatchesList } from 'waldur-js-client';

try {
  const response = await assignmentBatchesList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
call_uuid string (uuid)
o array Ordering
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
reviewer_pool_entry_uuid string (uuid)
reviewer_uuid string (uuid)
sent_after string (date-time)
sent_before string (date-time)
source array
status array

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
call string (uri)
call_uuid string (uuid)
call_name string
reviewer_pool_entry string (uri)
reviewer_pool_entry_uuid string (uuid)
reviewer_name string Get reviewer name from pool entry.
reviewer_email string Get reviewer email from pool entry.
reviewer_uuid string Get reviewer profile UUID if available.
status any
status_display string
sent_at string (date-time) When the invitation was sent to the reviewer.
expires_at string (date-time) When the invitation expires.
responded_at string (date-time) When the reviewer completed their response.
source any
source_display string
created_by string (uri) User who created/approved this batch.
created_by_name string
manager_notes string Optional notes from call manager to reviewer.
items_count integer Total count of items in batch.
items_pending_count integer Count of pending items.
items_accepted_count integer Count of accepted items.
items_declined_count integer Count of declined items.
is_expired boolean
created string (date-time)

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/assignment-batches/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.assignment_batches import assignment_batches_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = assignment_batches_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: assignment_batches_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { assignmentBatchesRetrieve } from 'waldur-js-client';

try {
  const response = await assignmentBatchesRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
url string (uri)
uuid string (uuid)
call string (uri)
call_uuid string (uuid)
call_name string
reviewer_pool_entry string (uri)
reviewer_pool_entry_uuid string (uuid)
reviewer_name string Get reviewer name from pool entry.
reviewer_email string Get reviewer email from pool entry.
reviewer_uuid string Get reviewer profile UUID if available.
status any
status_display string
sent_at string (date-time) When the invitation was sent to the reviewer.
expires_at string (date-time) When the invitation expires.
responded_at string (date-time) When the reviewer completed their response.
source any
source_display string
created_by string (uri) User who created/approved this batch.
created_by_name string
manager_notes string Optional notes from call manager to reviewer.
items array of objects
items.url string (uri)
items.uuid string (uuid)
items.batch string (uri)
items.proposal string (uri)
items.proposal_uuid string (uuid)
items.proposal_name string
items.proposal_slug string
items.status any
items.status_display string
items.affinity_score number (double) Affinity score used for assignment (0-1).
items.has_coi boolean Whether COI was detected during pre-check.
items.coi_count integer Count of COI records blocking this assignment.
items.responded_at string (date-time)
items.decline_reason string Reason provided by reviewer for declining.
items.review string (uri) The Review record created when this assignment was accepted.
items.review_uuid string (uuid)
items.reassign_count integer Number of times this proposal has been reassigned.
items.created string (date-time)
items_count integer Total count of items in batch.
items_pending_count integer Count of pending items.
items_accepted_count integer Count of accepted items.
items_declined_count integer Count of declined items.
is_expired boolean
created string (date-time)

Create

1
2
3
4
http \
  POST \
  https://api.example.com/api/assignment-batches/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.assignment_batch_request import AssignmentBatchRequest # (1)
from waldur_api_client.api.assignment_batches import assignment_batches_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = AssignmentBatchRequest()
response = assignment_batches_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: AssignmentBatchRequest
  2. API Source: assignment_batches_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { assignmentBatchesCreate } from 'waldur-js-client';

try {
  const response = await assignmentBatchesCreate({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
manager_notes string Optional notes from call manager to reviewer.

201 -

Field Type Description
url string (uri)
uuid string (uuid)
call string (uri)
call_uuid string (uuid)
call_name string
reviewer_pool_entry string (uri)
reviewer_pool_entry_uuid string (uuid)
reviewer_name string Get reviewer name from pool entry.
reviewer_email string Get reviewer email from pool entry.
reviewer_uuid string Get reviewer profile UUID if available.
status any
status_display string
sent_at string (date-time) When the invitation was sent to the reviewer.
expires_at string (date-time) When the invitation expires.
responded_at string (date-time) When the reviewer completed their response.
source any
source_display string
created_by string (uri) User who created/approved this batch.
created_by_name string
manager_notes string Optional notes from call manager to reviewer.
items array of objects
items.url string (uri)
items.uuid string (uuid)
items.batch string (uri)
items.proposal string (uri)
items.proposal_uuid string (uuid)
items.proposal_name string
items.proposal_slug string
items.status any
items.status_display string
items.affinity_score number (double) Affinity score used for assignment (0-1).
items.has_coi boolean Whether COI was detected during pre-check.
items.coi_count integer Count of COI records blocking this assignment.
items.responded_at string (date-time)
items.decline_reason string Reason provided by reviewer for declining.
items.review string (uri) The Review record created when this assignment was accepted.
items.review_uuid string (uuid)
items.reassign_count integer Number of times this proposal has been reassigned.
items.created string (date-time)
items_count integer Total count of items in batch.
items_pending_count integer Count of pending items.
items_accepted_count integer Count of accepted items.
items_declined_count integer Count of declined items.
is_expired boolean
created string (date-time)

Update

1
2
3
4
http \
  PUT \
  https://api.example.com/api/assignment-batches/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.assignment_batch_request import AssignmentBatchRequest # (1)
from waldur_api_client.api.assignment_batches import assignment_batches_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = AssignmentBatchRequest()
response = assignment_batches_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: AssignmentBatchRequest
  2. API Source: assignment_batches_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { assignmentBatchesUpdate } from 'waldur-js-client';

try {
  const response = await assignmentBatchesUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
manager_notes string Optional notes from call manager to reviewer.

200 -

Field Type Description
url string (uri)
uuid string (uuid)
call string (uri)
call_uuid string (uuid)
call_name string
reviewer_pool_entry string (uri)
reviewer_pool_entry_uuid string (uuid)
reviewer_name string Get reviewer name from pool entry.
reviewer_email string Get reviewer email from pool entry.
reviewer_uuid string Get reviewer profile UUID if available.
status any
status_display string
sent_at string (date-time) When the invitation was sent to the reviewer.
expires_at string (date-time) When the invitation expires.
responded_at string (date-time) When the reviewer completed their response.
source any
source_display string
created_by string (uri) User who created/approved this batch.
created_by_name string
manager_notes string Optional notes from call manager to reviewer.
items array of objects
items.url string (uri)
items.uuid string (uuid)
items.batch string (uri)
items.proposal string (uri)
items.proposal_uuid string (uuid)
items.proposal_name string
items.proposal_slug string
items.status any
items.status_display string
items.affinity_score number (double) Affinity score used for assignment (0-1).
items.has_coi boolean Whether COI was detected during pre-check.
items.coi_count integer Count of COI records blocking this assignment.
items.responded_at string (date-time)
items.decline_reason string Reason provided by reviewer for declining.
items.review string (uri) The Review record created when this assignment was accepted.
items.review_uuid string (uuid)
items.reassign_count integer Number of times this proposal has been reassigned.
items.created string (date-time)
items_count integer Total count of items in batch.
items_pending_count integer Count of pending items.
items_accepted_count integer Count of accepted items.
items_declined_count integer Count of declined items.
is_expired boolean
created string (date-time)

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/assignment-batches/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_assignment_batch_request import PatchedAssignmentBatchRequest # (1)
from waldur_api_client.api.assignment_batches import assignment_batches_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedAssignmentBatchRequest()
response = assignment_batches_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedAssignmentBatchRequest
  2. API Source: assignment_batches_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { assignmentBatchesPartialUpdate } from 'waldur-js-client';

try {
  const response = await assignmentBatchesPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
manager_notes string Optional notes from call manager to reviewer.

200 -

Field Type Description
url string (uri)
uuid string (uuid)
call string (uri)
call_uuid string (uuid)
call_name string
reviewer_pool_entry string (uri)
reviewer_pool_entry_uuid string (uuid)
reviewer_name string Get reviewer name from pool entry.
reviewer_email string Get reviewer email from pool entry.
reviewer_uuid string Get reviewer profile UUID if available.
status any
status_display string
sent_at string (date-time) When the invitation was sent to the reviewer.
expires_at string (date-time) When the invitation expires.
responded_at string (date-time) When the reviewer completed their response.
source any
source_display string
created_by string (uri) User who created/approved this batch.
created_by_name string
manager_notes string Optional notes from call manager to reviewer.
items array of objects
items.url string (uri)
items.uuid string (uuid)
items.batch string (uri)
items.proposal string (uri)
items.proposal_uuid string (uuid)
items.proposal_name string
items.proposal_slug string
items.status any
items.status_display string
items.affinity_score number (double) Affinity score used for assignment (0-1).
items.has_coi boolean Whether COI was detected during pre-check.
items.coi_count integer Count of COI records blocking this assignment.
items.responded_at string (date-time)
items.decline_reason string Reason provided by reviewer for declining.
items.review string (uri) The Review record created when this assignment was accepted.
items.review_uuid string (uuid)
items.reassign_count integer Number of times this proposal has been reassigned.
items.created string (date-time)
items_count integer Total count of items in batch.
items_pending_count integer Count of pending items.
items_accepted_count integer Count of accepted items.
items_declined_count integer Count of declined items.
is_expired boolean
created string (date-time)

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/assignment-batches/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.assignment_batches import assignment_batches_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = assignment_batches_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: assignment_batches_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { assignmentBatchesDestroy } from 'waldur-js-client';

try {
  const response = await assignmentBatchesDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Other Actions

Cancel this assignment batch

Cancel this assignment batch.

1
2
3
4
http \
  POST \
  https://api.example.com/api/assignment-batches/a1b2c3d4-e5f6-7890-abcd-ef1234567890/cancel/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.assignment_batches import assignment_batches_cancel # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = assignment_batches_cancel.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: assignment_batches_cancel
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { assignmentBatchesCancel } from 'waldur-js-client';

try {
  const response = await assignmentBatchesCancel({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
message string

Extend deadline

Extend or modify the expiration date for an assignment batch. Can reactivate expired batches by setting a future deadline.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/assignment-batches/a1b2c3d4-e5f6-7890-abcd-ef1234567890/extend-deadline/ \
  Authorization:"Token YOUR_API_TOKEN" \
  expires_at="2023-10-01T12:00:00Z"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.extend_deadline_request_request import ExtendDeadlineRequestRequest # (1)
from waldur_api_client.api.assignment_batches import assignment_batches_extend_deadline # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ExtendDeadlineRequestRequest(
    expires_at="2023-10-01T12:00:00Z"
)
response = assignment_batches_extend_deadline.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ExtendDeadlineRequestRequest
  2. API Source: assignment_batches_extend_deadline
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { assignmentBatchesExtendDeadline } from 'waldur-js-client';

try {
  const response = await assignmentBatchesExtendDeadline({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "expires_at": "2023-10-01T12:00:00Z"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
expires_at string (date-time) ✓ New expiration date and time for the assignment batch.

200 -

Field Type Description
expires_at string (date-time) The updated expiration date.
status string Current status of the batch.

Send this assignment batch invitation to the reviewer

Send this assignment batch invitation to the reviewer.

1
2
3
4
http \
  POST \
  https://api.example.com/api/assignment-batches/a1b2c3d4-e5f6-7890-abcd-ef1234567890/send/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.send_assignment_batch_request import SendAssignmentBatchRequest # (1)
from waldur_api_client.api.assignment_batches import assignment_batches_send # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = SendAssignmentBatchRequest()
response = assignment_batches_send.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: SendAssignmentBatchRequest
  2. API Source: assignment_batches_send
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { assignmentBatchesSend } from 'waldur-js-client';

try {
  const response = await assignmentBatchesSend({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
manager_notes string Optional notes to include in the invitation email

200 -

Field Type
detail string
expires_at string (date-time)

Assignment Items

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/assignment-items/ List Assignment Items
GET /api/assignment-items/{uuid}/ Retrieve
POST /api/assignment-items/ Create
PUT /api/assignment-items/{uuid}/ Update
PATCH /api/assignment-items/{uuid}/ Partial Update
DELETE /api/assignment-items/{uuid}/ Delete
Other Actions
GET /api/assignment-items/{uuid}/suggest_alternatives/ Suggest alternative reviewers for a declined assignment
POST /api/assignment-items/{uuid}/accept/ Accept this assignment item. Creates a Review record
POST /api/assignment-items/{uuid}/decline/ Decline this assignment item
POST /api/assignment-items/{uuid}/reassign/ Reassign this item to a different reviewer

Core CRUD

List Assignment Items

1
2
3
4
http \
  GET \
  https://api.example.com/api/assignment-items/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.assignment_item_o_enum import AssignmentItemOEnum # (1)
from waldur_api_client.models.assignment_item_status import AssignmentItemStatus # (2)
from waldur_api_client.api.assignment_items import assignment_items_list # (3)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = assignment_items_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: AssignmentItemOEnum
  2. Model Source: AssignmentItemStatus
  3. API Source: assignment_items_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { assignmentItemsList } from 'waldur-js-client';

try {
  const response = await assignmentItemsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
batch_uuid string (uuid)
call_uuid string (uuid)
has_coi boolean
min_affinity_score number (float)
o array Ordering
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
proposal_uuid string (uuid)
reviewer_uuid string (uuid)
status array

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
batch string (uri)
proposal string (uri)
proposal_uuid string (uuid)
proposal_name string
proposal_slug string
status any
status_display string
affinity_score number (double) Affinity score used for assignment (0-1).
has_coi boolean Whether COI was detected during pre-check.
coi_count integer Count of COI records blocking this assignment.
responded_at string (date-time)
decline_reason string Reason provided by reviewer for declining.
review string (uri) The Review record created when this assignment was accepted.
review_uuid string (uuid)
reassign_count integer Number of times this proposal has been reassigned.
created string (date-time)

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/assignment-items/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.assignment_items import assignment_items_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = assignment_items_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: assignment_items_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { assignmentItemsRetrieve } from 'waldur-js-client';

try {
  const response = await assignmentItemsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
url string (uri)
uuid string (uuid)
batch string (uri)
proposal string (uri)
proposal_uuid string (uuid)
proposal_name string
proposal_slug string
status any
status_display string
affinity_score number (double) Affinity score used for assignment (0-1).
has_coi boolean Whether COI was detected during pre-check.
coi_count integer Count of COI records blocking this assignment.
responded_at string (date-time)
decline_reason string Reason provided by reviewer for declining.
review string (uri) The Review record created when this assignment was accepted.
review_uuid string (uuid)
reassign_count integer Number of times this proposal has been reassigned.
created string (date-time)

Create

1
2
3
4
http \
  POST \
  https://api.example.com/api/assignment-items/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.assignment_item_request import AssignmentItemRequest # (1)
from waldur_api_client.api.assignment_items import assignment_items_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = AssignmentItemRequest()
response = assignment_items_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: AssignmentItemRequest
  2. API Source: assignment_items_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { assignmentItemsCreate } from 'waldur-js-client';

try {
  const response = await assignmentItemsCreate({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
decline_reason string Reason provided by reviewer for declining.

201 -

Field Type Description
url string (uri)
uuid string (uuid)
batch string (uri)
proposal string (uri)
proposal_uuid string (uuid)
proposal_name string
proposal_slug string
status any
status_display string
affinity_score number (double) Affinity score used for assignment (0-1).
has_coi boolean Whether COI was detected during pre-check.
coi_count integer Count of COI records blocking this assignment.
responded_at string (date-time)
decline_reason string Reason provided by reviewer for declining.
review string (uri) The Review record created when this assignment was accepted.
review_uuid string (uuid)
reassign_count integer Number of times this proposal has been reassigned.
created string (date-time)

Update

1
2
3
4
http \
  PUT \
  https://api.example.com/api/assignment-items/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.assignment_item_request import AssignmentItemRequest # (1)
from waldur_api_client.api.assignment_items import assignment_items_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = AssignmentItemRequest()
response = assignment_items_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: AssignmentItemRequest
  2. API Source: assignment_items_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { assignmentItemsUpdate } from 'waldur-js-client';

try {
  const response = await assignmentItemsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
decline_reason string Reason provided by reviewer for declining.

200 -

Field Type Description
url string (uri)
uuid string (uuid)
batch string (uri)
proposal string (uri)
proposal_uuid string (uuid)
proposal_name string
proposal_slug string
status any
status_display string
affinity_score number (double) Affinity score used for assignment (0-1).
has_coi boolean Whether COI was detected during pre-check.
coi_count integer Count of COI records blocking this assignment.
responded_at string (date-time)
decline_reason string Reason provided by reviewer for declining.
review string (uri) The Review record created when this assignment was accepted.
review_uuid string (uuid)
reassign_count integer Number of times this proposal has been reassigned.
created string (date-time)

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/assignment-items/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_assignment_item_request import PatchedAssignmentItemRequest # (1)
from waldur_api_client.api.assignment_items import assignment_items_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedAssignmentItemRequest()
response = assignment_items_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedAssignmentItemRequest
  2. API Source: assignment_items_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { assignmentItemsPartialUpdate } from 'waldur-js-client';

try {
  const response = await assignmentItemsPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
decline_reason string Reason provided by reviewer for declining.

200 -

Field Type Description
url string (uri)
uuid string (uuid)
batch string (uri)
proposal string (uri)
proposal_uuid string (uuid)
proposal_name string
proposal_slug string
status any
status_display string
affinity_score number (double) Affinity score used for assignment (0-1).
has_coi boolean Whether COI was detected during pre-check.
coi_count integer Count of COI records blocking this assignment.
responded_at string (date-time)
decline_reason string Reason provided by reviewer for declining.
review string (uri) The Review record created when this assignment was accepted.
review_uuid string (uuid)
reassign_count integer Number of times this proposal has been reassigned.
created string (date-time)

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/assignment-items/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.assignment_items import assignment_items_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = assignment_items_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: assignment_items_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { assignmentItemsDestroy } from 'waldur-js-client';

try {
  const response = await assignmentItemsDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Other Actions

Suggest alternative reviewers for a declined assignment

Suggest alternative reviewers for a declined assignment.

1
2
3
4
http \
  GET \
  https://api.example.com/api/assignment-items/a1b2c3d4-e5f6-7890-abcd-ef1234567890/suggest_alternatives/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.assignment_items import assignment_items_suggest_alternatives_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = assignment_items_suggest_alternatives_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: assignment_items_suggest_alternatives_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { assignmentItemsSuggestAlternativesRetrieve } from 'waldur-js-client';

try {
  const response = await assignmentItemsSuggestAlternativesRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
suggestions array of objects List of alternative reviewers with affinity scores

Accept this assignment item. Creates a Review record

Accept this assignment item. Creates a Review record.

1
2
3
4
http \
  POST \
  https://api.example.com/api/assignment-items/a1b2c3d4-e5f6-7890-abcd-ef1234567890/accept/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.assignment_items import assignment_items_accept # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = assignment_items_accept.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: assignment_items_accept
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { assignmentItemsAccept } from 'waldur-js-client';

try {
  const response = await assignmentItemsAccept({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
detail string
review_uuid string (uuid) UUID of created review (only on accept)

Decline this assignment item

Decline this assignment item.

1
2
3
4
http \
  POST \
  https://api.example.com/api/assignment-items/a1b2c3d4-e5f6-7890-abcd-ef1234567890/decline/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.assignment_item_decline_request import AssignmentItemDeclineRequest # (1)
from waldur_api_client.api.assignment_items import assignment_items_decline # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = AssignmentItemDeclineRequest()
response = assignment_items_decline.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: AssignmentItemDeclineRequest
  2. API Source: assignment_items_decline
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { assignmentItemsDecline } from 'waldur-js-client';

try {
  const response = await assignmentItemsDecline({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
reason string Reason for declining this assignment

200 -

Field Type Description
detail string
review_uuid string (uuid) UUID of created review (only on accept)

Reassign this item to a different reviewer

Reassign this item to a different reviewer.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/assignment-items/a1b2c3d4-e5f6-7890-abcd-ef1234567890/reassign/ \
  Authorization:"Token YOUR_API_TOKEN" \
  reviewer_pool_entry_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.reassign_item_request import ReassignItemRequest # (1)
from waldur_api_client.api.assignment_items import assignment_items_reassign # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ReassignItemRequest(
    reviewer_pool_entry_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
)
response = assignment_items_reassign.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ReassignItemRequest
  2. API Source: assignment_items_reassign
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { assignmentItemsReassign } from 'waldur-js-client';

try {
  const response = await assignmentItemsReassign({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "reviewer_pool_entry_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
reviewer_pool_entry_uuid string (uuid) ✓ UUID of the pool entry for the new reviewer
manager_notes string Notes to include in the reassignment notification

200 -

Field Type
detail string
new_item_uuid string (uuid)
new_batch_uuid string (uuid)

My Assignment Batches

Operations Summary

Method Endpoint Description
GET /api/my-assignment-batches/ List all pending assignment batches for the authenticated reviewer
GET /api/my-assignment-batches/{uuid}/ Get details of a specific assignment batch with items

List all pending assignment batches for the authenticated reviewer

List all pending assignment batches for the authenticated reviewer.

1
2
3
4
http \
  GET \
  https://api.example.com/api/my-assignment-batches/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.my_assignment_batches import my_assignment_batches_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = my_assignment_batches_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: my_assignment_batches_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { myAssignmentBatchesList } from 'waldur-js-client';

try {
  const response = await myAssignmentBatchesList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
uuid string (uuid)
call_uuid string (uuid)
call_name string
status string
status_display string
sent_at string (date-time)
expires_at string (date-time)
is_expired boolean
items_count integer
items_pending_count integer
manager_notes string

Get details of a specific assignment batch with items

Get details of a specific assignment batch with items.

1
2
3
4
http \
  GET \
  https://api.example.com/api/my-assignment-batches/string-value/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.my_assignment_batches import my_assignment_batches_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = my_assignment_batches_retrieve.sync(
    uuid="string-value",
    client=client
)

print(response)
  1. API Source: my_assignment_batches_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { myAssignmentBatchesRetrieve } from 'waldur-js-client';

try {
  const response = await myAssignmentBatchesRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
uuid string ✓ UUID of the assignment batch

200 -

Field Type
uuid string (uuid)
call_uuid string (uuid)
call_name string
status string
status_display string
sent_at string (date-time)
expires_at string (date-time)
is_expired boolean
items_count integer
items_pending_count integer
manager_notes string
items array of objects
items.uuid string (uuid)
items.proposal_uuid string (uuid)
items.proposal_name string
items.proposal_slug string
items.proposal_summary string
items.status string
items.status_display string
items.affinity_score number (double)
items.has_coi boolean

Proposal Proposals

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/proposal-proposals/ List Proposal Proposals
GET /api/proposal-proposals/{uuid}/ Retrieve
POST /api/proposal-proposals/ Create
POST /api/proposal-proposals/{uuid}/update_project_details/ Update project details of a proposal
DELETE /api/proposal-proposals/{uuid}/ Delete
Permissions & Users
GET /api/proposal-proposals/{uuid}/list_users/ List users and their roles in a scope
POST /api/proposal-proposals/{uuid}/add_user/ Grant a role to a user
POST /api/proposal-proposals/{uuid}/delete_user/ Revoke a role from a user
POST /api/proposal-proposals/{uuid}/update_user/ Update a user's role expiration
Other Actions
GET /api/proposal-proposals/{uuid}/checklist/ Get checklist with questions and existing answers
GET /api/proposal-proposals/{uuid}/checklist_review/ Checklist review
GET /api/proposal-proposals/checklist-template/ Get checklist template for creating new objects
GET /api/proposal-proposals/{uuid}/completion_review_status/ Get checklist completion status with review triggers (reviewers only)
GET /api/proposal-proposals/{uuid}/completion_status/ Get checklist completion status
GET /api/proposal-proposals/{uuid}/resources/ List resources for a proposal
GET /api/proposal-proposals/{uuid}/resources/{obj_uuid}/ Retrieve
POST /api/proposal-proposals/{uuid}/approve/ Approve a proposal
POST /api/proposal-proposals/{uuid}/attach_document/ Attach document to proposal
POST /api/proposal-proposals/{uuid}/detach_documents/ Detach documents from proposal
POST /api/proposal-proposals/{uuid}/reject/ Reject a proposal
POST /api/proposal-proposals/{uuid}/resources/ Create resource for a proposal
POST /api/proposal-proposals/{uuid}/submit/ Submit a proposal
POST /api/proposal-proposals/{uuid}/submit_answers/ Submit checklist answers
PUT /api/proposal-proposals/{uuid}/resources/{obj_uuid}/ Update
PATCH /api/proposal-proposals/{uuid}/resources/{obj_uuid}/ Partial Update
DELETE /api/proposal-proposals/{uuid}/resources/{obj_uuid}/ Delete

Core CRUD

List Proposal Proposals

1
2
3
4
http \
  GET \
  https://api.example.com/api/proposal-proposals/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.proposal_o_enum import ProposalOEnum # (1)
from waldur_api_client.models.proposal_states import ProposalStates # (2)
from waldur_api_client.api.proposal_proposals import proposal_proposals_list # (3)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = proposal_proposals_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: ProposalOEnum
  2. Model Source: ProposalStates
  3. API Source: proposal_proposals_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { proposalProposalsList } from 'waldur-js-client';

try {
  const response = await proposalProposalsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
call_uuid string (uuid)
created_by_uuid string (uuid)
my_proposals boolean
name string
o array Ordering
organization_uuid string (uuid)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
round string (uuid)
round_uuid string (uuid)
state array

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid)
url string (uri)
slug string
name string
description string
project_name string
project_summary string
project_is_confidential boolean
project_has_civilian_purpose boolean
supporting_documentation array of objects
supporting_documentation.uuid string (uuid)
supporting_documentation.file string (uri) Upload supporting documentation in PDF format.
supporting_documentation.file_name string
supporting_documentation.file_size integer
supporting_documentation.created string (date-time)
state any
approved_by string (uri)
created_by string (uri)
created_by_name string
created_by_uuid string (uuid)
duration_in_days integer Duration in days after provisioning of resources.
project string (uri)
round any
call_uuid string (uuid)
call_name string
call_managing_organisation_uuid string (uuid)
oecd_fos_2007_code any
oecd_fos_2007_label string
allocation_comment string
created string (date-time)
compliance_status object (free-form)
can_submit object (free-form)

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/proposal-proposals/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.proposal_proposals import proposal_proposals_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = proposal_proposals_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: proposal_proposals_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { proposalProposalsRetrieve } from 'waldur-js-client';

try {
  const response = await proposalProposalsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
uuid string (uuid)
url string (uri)
slug string
name string
description string
project_name string
project_summary string
project_is_confidential boolean
project_has_civilian_purpose boolean
supporting_documentation array of objects
supporting_documentation.uuid string (uuid)
supporting_documentation.file string (uri) Upload supporting documentation in PDF format.
supporting_documentation.file_name string
supporting_documentation.file_size integer
supporting_documentation.created string (date-time)
state any
approved_by string (uri)
created_by string (uri)
created_by_name string
created_by_uuid string (uuid)
duration_in_days integer Duration in days after provisioning of resources.
project string (uri)
round any
call_uuid string (uuid)
call_name string
call_managing_organisation_uuid string (uuid)
oecd_fos_2007_code any
oecd_fos_2007_label string
allocation_comment string
created string (date-time)
compliance_status object (free-form)
can_submit object (free-form)

Create

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/proposal-proposals/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-proposal-proposal" \
  round_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.proposal_request import ProposalRequest # (1)
from waldur_api_client.api.proposal_proposals import proposal_proposals_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ProposalRequest(
    name="my-awesome-proposal-proposal",
    round_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
)
response = proposal_proposals_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ProposalRequest
  2. API Source: proposal_proposals_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { proposalProposalsCreate } from 'waldur-js-client';

try {
  const response = await proposalProposalsCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "name": "my-awesome-proposal-proposal",
    "round_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
name string ✓
description string
project_summary string
project_is_confidential boolean
project_has_civilian_purpose boolean
duration_in_days integer Duration in days after provisioning of resources.
round_uuid string (uuid) ✓
Constraints: write-only
oecd_fos_2007_code any

201 -

Field Type Description
uuid string (uuid)
url string (uri)
slug string
name string
description string
project_name string
project_summary string
project_is_confidential boolean
project_has_civilian_purpose boolean
supporting_documentation array of objects
supporting_documentation.uuid string (uuid)
supporting_documentation.file string (uri) Upload supporting documentation in PDF format.
supporting_documentation.file_name string
supporting_documentation.file_size integer
supporting_documentation.created string (date-time)
state any
approved_by string (uri)
created_by string (uri)
created_by_name string
created_by_uuid string (uuid)
duration_in_days integer Duration in days after provisioning of resources.
project string (uri)
round any
call_uuid string (uuid)
call_name string
call_managing_organisation_uuid string (uuid)
oecd_fos_2007_code any
oecd_fos_2007_label string
allocation_comment string
created string (date-time)
compliance_status object (free-form)
can_submit object (free-form)

Update project details of a proposal

Update project details of a proposal.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/proposal-proposals/a1b2c3d4-e5f6-7890-abcd-ef1234567890/update_project_details/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-proposal-proposal"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.proposal_update_project_details_request import ProposalUpdateProjectDetailsRequest # (1)
from waldur_api_client.api.proposal_proposals import proposal_proposals_update_project_details # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ProposalUpdateProjectDetailsRequest(
    name="my-awesome-proposal-proposal"
)
response = proposal_proposals_update_project_details.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ProposalUpdateProjectDetailsRequest
  2. API Source: proposal_proposals_update_project_details
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { proposalProposalsUpdateProjectDetails } from 'waldur-js-client';

try {
  const response = await proposalProposalsUpdateProjectDetails({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-proposal-proposal"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
name string ✓
description string
project_summary string
project_is_confidential boolean
project_has_civilian_purpose boolean
duration_in_days integer Duration in days after provisioning of resources.
oecd_fos_2007_code any

200 - No response body

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/proposal-proposals/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.proposal_proposals import proposal_proposals_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = proposal_proposals_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: proposal_proposals_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { proposalProposalsDestroy } from 'waldur-js-client';

try {
  const response = await proposalProposalsDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Permissions & Users

List users and their roles in a scope

Retrieves a list of users who have a role within a specific scope (e.g., a project or an organization). The list can be filtered by user details or role.

1
2
3
4
http \
  GET \
  https://api.example.com/api/proposal-proposals/a1b2c3d4-e5f6-7890-abcd-ef1234567890/list_users/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.user_role_details_field_enum import UserRoleDetailsFieldEnum # (1)
from waldur_api_client.models.user_role_details_o_enum import UserRoleDetailsOEnum # (2)
from waldur_api_client.api.proposal_proposals import proposal_proposals_list_users_list # (3)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = proposal_proposals_list_users_list.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

for item in response:
    print(item)
  1. Model Source: UserRoleDetailsFieldEnum
  2. Model Source: UserRoleDetailsOEnum
  3. API Source: proposal_proposals_list_users_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { proposalProposalsListUsersList } from 'waldur-js-client';

try {
  const response = await proposalProposalsListUsersList({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type Description
field array Fields to include in response
full_name string User full name
native_name string User native name
o array Ordering fields
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
role string (uuid) Role UUID or name
search_string string Search string for user
user string (uuid) User UUID
user_slug string User slug
user_url string User URL
username string User username

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid)
created string (date-time)
expiration_time string (date-time)
role_name string
role_uuid string (uuid)
user_email string (email)
user_full_name string
user_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
user_uuid string (uuid)
user_image string (uri)
created_by_full_name string
created_by_uuid string (uuid)

Grant a role to a user

Assigns a specific role to a user within the current scope. An optional expiration time for the role can be set.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/proposal-proposals/a1b2c3d4-e5f6-7890-abcd-ef1234567890/add_user/ \
  Authorization:"Token YOUR_API_TOKEN" \
  role="string-value" \
  user="a1b2c3d4-e5f6-7890-abcd-ef1234567890"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.user_role_create_request import UserRoleCreateRequest # (1)
from waldur_api_client.api.proposal_proposals import proposal_proposals_add_user # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = UserRoleCreateRequest(
    role="string-value",
    user="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
)
response = proposal_proposals_add_user.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: UserRoleCreateRequest
  2. API Source: proposal_proposals_add_user
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { proposalProposalsAddUser } from 'waldur-js-client';

try {
  const response = await proposalProposalsAddUser({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "role": "string-value",
    "user": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
role string ✓
user string (uuid) ✓
expiration_time string (date-time)

201 -

Field Type
expiration_time string (date-time)

400 - Validation error, for example when trying to add a user to a terminated project.

Revoke a role from a user

Removes a specific role from a user within the current scope. This effectively revokes their permissions associated with that role.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/proposal-proposals/a1b2c3d4-e5f6-7890-abcd-ef1234567890/delete_user/ \
  Authorization:"Token YOUR_API_TOKEN" \
  role="string-value" \
  user="a1b2c3d4-e5f6-7890-abcd-ef1234567890"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.user_role_delete_request import UserRoleDeleteRequest # (1)
from waldur_api_client.api.proposal_proposals import proposal_proposals_delete_user # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = UserRoleDeleteRequest(
    role="string-value",
    user="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
)
response = proposal_proposals_delete_user.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: UserRoleDeleteRequest
  2. API Source: proposal_proposals_delete_user
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { proposalProposalsDeleteUser } from 'waldur-js-client';

try {
  const response = await proposalProposalsDeleteUser({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "role": "string-value",
    "user": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
role string ✓
user string (uuid) ✓
expiration_time string (date-time)

200 - Role revoked successfully.

Update a user's role expiration

Updates the expiration time for a user's existing role in the current scope. This is useful for extending or shortening the duration of a permission. To make a role permanent, set expiration_time to null.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/proposal-proposals/a1b2c3d4-e5f6-7890-abcd-ef1234567890/update_user/ \
  Authorization:"Token YOUR_API_TOKEN" \
  role="string-value" \
  user="a1b2c3d4-e5f6-7890-abcd-ef1234567890"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.user_role_update_request import UserRoleUpdateRequest # (1)
from waldur_api_client.api.proposal_proposals import proposal_proposals_update_user # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = UserRoleUpdateRequest(
    role="string-value",
    user="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
)
response = proposal_proposals_update_user.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: UserRoleUpdateRequest
  2. API Source: proposal_proposals_update_user
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { proposalProposalsUpdateUser } from 'waldur-js-client';

try {
  const response = await proposalProposalsUpdateUser({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "role": "string-value",
    "user": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
role string ✓
user string (uuid) ✓
expiration_time string (date-time)

200 -

Field Type
expiration_time string (date-time)

Other Actions

Get checklist with questions and existing answers

Get checklist with questions and existing answers.

1
2
3
4
http \
  GET \
  https://api.example.com/api/proposal-proposals/a1b2c3d4-e5f6-7890-abcd-ef1234567890/checklist/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.proposal_proposals import proposal_proposals_checklist_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = proposal_proposals_checklist_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: proposal_proposals_checklist_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { proposalProposalsChecklistRetrieve } from 'waldur-js-client';

try {
  const response = await proposalProposalsChecklistRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type Description
include_all boolean If true, returns all questions including hidden ones (for dynamic form visibility). Default: false.

200 -

Field Type Description
checklist object (free-form)
completion object
completion.uuid string (uuid)
completion.is_completed boolean Whether all required questions have been answered
completion.completion_percentage number (double)
completion.unanswered_required_questions array of anys
completion.checklist_name string
completion.checklist_description string
completion.created string (date-time)
completion.modified string (date-time)
questions array of objects
questions.uuid string (uuid)
questions.description string
questions.user_guidance string
questions.question_type any Type of question and expected answer format
questions.required boolean
questions.order integer
questions.existing_answer object (free-form)
questions.question_options array of anys
questions.min_value string (decimal) Minimum value allowed for NUMBER, YEAR, and RATING type questions
questions.max_value string (decimal) Maximum value allowed for NUMBER, YEAR, and RATING type questions
questions.allowed_file_types any List of allowed file extensions (e.g., ['.pdf', '.doc', '.docx']). If empty, all file types are allowed.
questions.allowed_mime_types any List of allowed MIME types (e.g., ['application/pdf', 'application/msword']). If empty, MIME type validation is not enforced. When both extensions and MIME types are specified, files must match both criteria for security.
questions.max_file_size_mb integer Maximum file size in megabytes. If not set, no size limit is enforced.
questions.max_files_count integer Maximum number of files allowed for MULTIPLE_FILES type questions. If not set, no count limit is enforced.
questions.dependencies_info object (free-form)

400 -

404 -

Checklist review

Get checklist with questions and existing answers including review logic (reviewers only).

1
2
3
4
http \
  GET \
  https://api.example.com/api/proposal-proposals/a1b2c3d4-e5f6-7890-abcd-ef1234567890/checklist_review/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.proposal_proposals import proposal_proposals_checklist_review_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = proposal_proposals_checklist_review_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: proposal_proposals_checklist_review_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { proposalProposalsChecklistReviewRetrieve } from 'waldur-js-client';

try {
  const response = await proposalProposalsChecklistReviewRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
checklist object (free-form)
completion object
completion.uuid string (uuid)
completion.is_completed boolean Whether all required questions have been answered
completion.completion_percentage number (double)
completion.unanswered_required_questions array of anys
completion.checklist_name string
completion.checklist_description string
completion.created string (date-time)
completion.modified string (date-time)
completion.requires_review boolean Whether any answers triggered review requirements
completion.reviewed_by integer User who reviewed the checklist completion
completion.reviewed_by_name string
completion.reviewed_at string (date-time)
completion.review_notes string Notes from the reviewer
completion.review_trigger_summary array of anys
questions array of objects
questions.uuid string (uuid)
questions.description string
questions.user_guidance string
questions.question_type any Type of question and expected answer format
questions.required boolean
questions.order integer
questions.existing_answer object (free-form)
questions.question_options array of anys
questions.min_value string (decimal) Minimum value allowed for NUMBER, YEAR, and RATING type questions
questions.max_value string (decimal) Maximum value allowed for NUMBER, YEAR, and RATING type questions
questions.allowed_file_types any List of allowed file extensions (e.g., ['.pdf', '.doc', '.docx']). If empty, all file types are allowed.
questions.allowed_mime_types any List of allowed MIME types (e.g., ['application/pdf', 'application/msword']). If empty, MIME type validation is not enforced. When both extensions and MIME types are specified, files must match both criteria for security.
questions.max_file_size_mb integer Maximum file size in megabytes. If not set, no size limit is enforced.
questions.max_files_count integer Maximum number of files allowed for MULTIPLE_FILES type questions. If not set, no count limit is enforced.
questions.dependencies_info object (free-form)
questions.operator any
questions.review_answer_value any Answer value that trigger review.
questions.always_requires_review boolean This question always requires review regardless of answer

400 -

404 -

Get checklist template for creating new objects

Get checklist template for creating new objects.

1
2
3
4
5
http \
  GET \
  https://api.example.com/api/proposal-proposals/checklist-template/ \
  Authorization:"Token YOUR_API_TOKEN" \
  parent_uuid=="a1b2c3d4-e5f6-7890-abcd-ef1234567890"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.proposal_proposals import proposal_proposals_checklist_template_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = proposal_proposals_checklist_template_retrieve.sync(
    client=client,
    parent_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
)

print(response)
  1. API Source: proposal_proposals_checklist_template_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { proposalProposalsChecklistTemplateRetrieve } from 'waldur-js-client';

try {
  const response = await proposalProposalsChecklistTemplateRetrieve({
  auth: "Token YOUR_API_TOKEN",
  query: {
    "parent_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
parent_uuid string (uuid) ✓ UUID of the parent object (e.g., customer UUID for new projects)

200 -

Field Type Description
checklist object (free-form)
questions array of objects
questions.uuid string (uuid)
questions.required boolean
questions.description string
questions.user_guidance string Additional guidance text visible to users when answering and reviewing
questions.question_options array of objects
questions.question_options.uuid string (uuid)
questions.question_options.label string
questions.question_options.order integer
questions.question_type any Type of question and expected answer format
questions.order integer
questions.min_value string (decimal) Minimum value allowed for NUMBER, YEAR, and RATING type questions
questions.max_value string (decimal) Maximum value allowed for NUMBER, YEAR, and RATING type questions
questions.allowed_file_types any List of allowed file extensions (e.g., ['.pdf', '.doc', '.docx']). If empty, all file types are allowed.
questions.allowed_mime_types any List of allowed MIME types (e.g., ['application/pdf', 'application/msword']). If empty, MIME type validation is not enforced. When both extensions and MIME types are specified, files must match both criteria for security.
questions.max_file_size_mb integer Maximum file size in megabytes. If not set, no size limit is enforced.
questions.max_files_count integer Maximum number of files allowed for MULTIPLE_FILES type questions. If not set, no count limit is enforced.
questions.operator any
questions.review_answer_value any Answer value that trigger review.
questions.always_requires_review boolean This question always requires review regardless of answer
questions.guidance_answer_value any Answer value that triggers display of user guidance.
questions.guidance_operator any Operator to use when comparing answer with guidance_answer_value
questions.always_show_guidance boolean Show user guidance always, regardless of answer. If False, guidance is conditional on answer matching guidance_answer_value with guidance_operator
questions.dependency_logic_operator any Defines how multiple dependencies are evaluated. AND: All dependencies must be satisfied. OR: At least one dependency must be satisfied.
initial_visible_questions array of objects
initial_visible_questions.uuid string (uuid)
initial_visible_questions.required boolean
initial_visible_questions.description string
initial_visible_questions.user_guidance string Additional guidance text visible to users when answering and reviewing
initial_visible_questions.question_options array of objects
initial_visible_questions.question_options.uuid string (uuid)
initial_visible_questions.question_options.label string
initial_visible_questions.question_options.order integer
initial_visible_questions.question_type any Type of question and expected answer format
initial_visible_questions.order integer
initial_visible_questions.min_value string (decimal) Minimum value allowed for NUMBER, YEAR, and RATING type questions
initial_visible_questions.max_value string (decimal) Maximum value allowed for NUMBER, YEAR, and RATING type questions
initial_visible_questions.allowed_file_types any List of allowed file extensions (e.g., ['.pdf', '.doc', '.docx']). If empty, all file types are allowed.
initial_visible_questions.allowed_mime_types any List of allowed MIME types (e.g., ['application/pdf', 'application/msword']). If empty, MIME type validation is not enforced. When both extensions and MIME types are specified, files must match both criteria for security.
initial_visible_questions.max_file_size_mb integer Maximum file size in megabytes. If not set, no size limit is enforced.
initial_visible_questions.max_files_count integer Maximum number of files allowed for MULTIPLE_FILES type questions. If not set, no count limit is enforced.
initial_visible_questions.operator any
initial_visible_questions.review_answer_value any Answer value that trigger review.
initial_visible_questions.always_requires_review boolean This question always requires review regardless of answer
initial_visible_questions.guidance_answer_value any Answer value that triggers display of user guidance.
initial_visible_questions.guidance_operator any Operator to use when comparing answer with guidance_answer_value
initial_visible_questions.always_show_guidance boolean Show user guidance always, regardless of answer. If False, guidance is conditional on answer matching guidance_answer_value with guidance_operator
initial_visible_questions.dependency_logic_operator any Defines how multiple dependencies are evaluated. AND: All dependencies must be satisfied. OR: At least one dependency must be satisfied.

400 -

404 -

Get checklist completion status with review triggers (reviewers only)

Get checklist completion status with review triggers (reviewers only).

1
2
3
4
http \
  GET \
  https://api.example.com/api/proposal-proposals/a1b2c3d4-e5f6-7890-abcd-ef1234567890/completion_review_status/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.proposal_proposals import proposal_proposals_completion_review_status_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = proposal_proposals_completion_review_status_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: proposal_proposals_completion_review_status_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { proposalProposalsCompletionReviewStatusRetrieve } from 'waldur-js-client';

try {
  const response = await proposalProposalsCompletionReviewStatusRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
uuid string (uuid)
is_completed boolean Whether all required questions have been answered
completion_percentage number (double)
unanswered_required_questions array of anys
checklist_name string
checklist_description string
created string (date-time)
modified string (date-time)
requires_review boolean Whether any answers triggered review requirements
reviewed_by integer User who reviewed the checklist completion
reviewed_by_name string
reviewed_at string (date-time)
review_notes string Notes from the reviewer
review_trigger_summary array of anys

400 -

404 -

Get checklist completion status

Get checklist completion status.

1
2
3
4
http \
  GET \
  https://api.example.com/api/proposal-proposals/a1b2c3d4-e5f6-7890-abcd-ef1234567890/completion_status/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.proposal_proposals import proposal_proposals_completion_status_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = proposal_proposals_completion_status_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: proposal_proposals_completion_status_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { proposalProposalsCompletionStatusRetrieve } from 'waldur-js-client';

try {
  const response = await proposalProposalsCompletionStatusRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
uuid string (uuid)
is_completed boolean Whether all required questions have been answered
completion_percentage number (double)
unanswered_required_questions array of anys
checklist_name string
checklist_description string
created string (date-time)
modified string (date-time)

400 -

404 -

List resources for a proposal

List resources for a proposal.

1
2
3
4
http \
  GET \
  https://api.example.com/api/proposal-proposals/a1b2c3d4-e5f6-7890-abcd-ef1234567890/resources/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.proposal_proposals import proposal_proposals_resources_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = proposal_proposals_resources_list.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

for item in response:
    print(item)
  1. API Source: proposal_proposals_resources_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { proposalProposalsResourcesList } from 'waldur-js-client';

try {
  const response = await proposalProposalsResourcesList({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
uuid string (uuid)
url string
requested_offering any
resource string (uri)
resource_name string
call_resource_template string
call_resource_template_name string
attributes any
limits any
description string
created_by string (uri)
created_by_name string

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/proposal-proposals/string-value/resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.proposal_proposals import proposal_proposals_resources_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = proposal_proposals_resources_retrieve.sync(
    obj_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    uuid="string-value",
    client=client
)

print(response)
  1. API Source: proposal_proposals_resources_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { proposalProposalsResourcesRetrieve } from 'waldur-js-client';

try {
  const response = await proposalProposalsResourcesRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "obj_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "uuid": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
obj_uuid string ✓
uuid string ✓

200 -

Field Type
uuid string (uuid)
url string
requested_offering any
resource string (uri)
resource_name string
call_resource_template string
call_resource_template_name string
attributes any
limits any
description string
created_by string (uri)
created_by_name string

Approve a proposal

Approve a proposal.

1
2
3
4
http \
  POST \
  https://api.example.com/api/proposal-proposals/a1b2c3d4-e5f6-7890-abcd-ef1234567890/approve/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.proposal_approve_request import ProposalApproveRequest # (1)
from waldur_api_client.api.proposal_proposals import proposal_proposals_approve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ProposalApproveRequest()
response = proposal_proposals_approve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ProposalApproveRequest
  2. API Source: proposal_proposals_approve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { proposalProposalsApprove } from 'waldur-js-client';

try {
  const response = await proposalProposalsApprove({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
allocation_comment string

200 - No response body

Attach document to proposal

Attach document to proposal.

1
2
3
4
http \
  POST \
  https://api.example.com/api/proposal-proposals/a1b2c3d4-e5f6-7890-abcd-ef1234567890/attach_document/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.proposal_documentation_request import ProposalDocumentationRequest # (1)
from waldur_api_client.api.proposal_proposals import proposal_proposals_attach_document # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ProposalDocumentationRequest()
response = proposal_proposals_attach_document.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ProposalDocumentationRequest
  2. API Source: proposal_proposals_attach_document
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { proposalProposalsAttachDocument } from 'waldur-js-client';

try {
  const response = await proposalProposalsAttachDocument({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
file string (binary) Upload supporting documentation in PDF format.

200 - No response body

Detach documents from proposal

Detach documents from proposal.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/proposal-proposals/a1b2c3d4-e5f6-7890-abcd-ef1234567890/detach_documents/ \
  Authorization:"Token YOUR_API_TOKEN" \
  documents:='[]'

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.proposal_detach_documents_request import ProposalDetachDocumentsRequest # (1)
from waldur_api_client.api.proposal_proposals import proposal_proposals_detach_documents # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ProposalDetachDocumentsRequest(
    documents=[]
)
response = proposal_proposals_detach_documents.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ProposalDetachDocumentsRequest
  2. API Source: proposal_proposals_detach_documents
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { proposalProposalsDetachDocuments } from 'waldur-js-client';

try {
  const response = await proposalProposalsDetachDocuments({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "documents": []
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
documents array of string (uuid)s ✓

200 - No response body

Reject a proposal

Reject a proposal.

1
2
3
4
http \
  POST \
  https://api.example.com/api/proposal-proposals/a1b2c3d4-e5f6-7890-abcd-ef1234567890/reject/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.proposal_approve_request import ProposalApproveRequest # (1)
from waldur_api_client.api.proposal_proposals import proposal_proposals_reject # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ProposalApproveRequest()
response = proposal_proposals_reject.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ProposalApproveRequest
  2. API Source: proposal_proposals_reject
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { proposalProposalsReject } from 'waldur-js-client';

try {
  const response = await proposalProposalsReject({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
allocation_comment string

200 - No response body

Create resource for a proposal

Create resource for a proposal.

1
2
3
4
http \
  POST \
  https://api.example.com/api/proposal-proposals/a1b2c3d4-e5f6-7890-abcd-ef1234567890/resources/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.requested_resource_request import RequestedResourceRequest # (1)
from waldur_api_client.api.proposal_proposals import proposal_proposals_resources_set # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = RequestedResourceRequest()
response = proposal_proposals_resources_set.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: RequestedResourceRequest
  2. API Source: proposal_proposals_resources_set
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { proposalProposalsResourcesSet } from 'waldur-js-client';

try {
  const response = await proposalProposalsResourcesSet({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
attributes any
limits any
description string
requested_offering_uuid string (uuid)
call_resource_template_uuid string (uuid)

200 -

Field Type
uuid string (uuid)
url string
requested_offering any
resource string (uri)
resource_name string
call_resource_template string
call_resource_template_name string
attributes any
limits any
description string
created_by string (uri)
created_by_name string

Submit a proposal

Submit a proposal.

1
2
3
4
http \
  POST \
  https://api.example.com/api/proposal-proposals/a1b2c3d4-e5f6-7890-abcd-ef1234567890/submit/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.proposal_proposals import proposal_proposals_submit # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = proposal_proposals_submit.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: proposal_proposals_submit
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { proposalProposalsSubmit } from 'waldur-js-client';

try {
  const response = await proposalProposalsSubmit({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 - No response body

Submit checklist answers

Submit checklist answers.

1
2
3
4
echo '[{"question_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "answer_data": null}]' | http \
  POST \
  https://api.example.com/api/proposal-proposals/a1b2c3d4-e5f6-7890-abcd-ef1234567890/submit_answers/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.proposal_proposals import proposal_proposals_submit_answers # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = proposal_proposals_submit_answers.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: proposal_proposals_submit_answers
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { proposalProposalsSubmitAnswers } from 'waldur-js-client';

try {
  const response = await proposalProposalsSubmitAnswers({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: [{"question_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "answer_data": null}]
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

The request body is an array of objects, where each object has the following structure:

Field Type Required
question_uuid string (uuid) ✓
answer_data any ✓

200 -

Field Type Description
detail string
completion object
completion.uuid string (uuid)
completion.is_completed boolean Whether all required questions have been answered
completion.completion_percentage number (double)
completion.unanswered_required_questions array of anys
completion.checklist_name string
completion.checklist_description string
completion.created string (date-time)
completion.modified string (date-time)
completion.requires_review boolean Whether any answers triggered review requirements
completion.reviewed_by integer User who reviewed the checklist completion
completion.reviewed_by_name string
completion.reviewed_at string (date-time)
completion.review_notes string Notes from the reviewer
completion.review_trigger_summary array of anys

400 -

404 -

Update

1
2
3
4
http \
  PUT \
  https://api.example.com/api/proposal-proposals/string-value/resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.requested_resource_request import RequestedResourceRequest # (1)
from waldur_api_client.api.proposal_proposals import proposal_proposals_resources_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = RequestedResourceRequest()
response = proposal_proposals_resources_update.sync(
    obj_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    uuid="string-value",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: RequestedResourceRequest
  2. API Source: proposal_proposals_resources_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { proposalProposalsResourcesUpdate } from 'waldur-js-client';

try {
  const response = await proposalProposalsResourcesUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "obj_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "uuid": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
obj_uuid string ✓
uuid string ✓
Field Type Required
attributes any
limits any
description string
requested_offering_uuid string (uuid)
call_resource_template_uuid string (uuid)

200 -

Field Type
uuid string (uuid)
url string
requested_offering any
resource string (uri)
resource_name string
call_resource_template string
call_resource_template_name string
attributes any
limits any
description string
created_by string (uri)
created_by_name string

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/proposal-proposals/string-value/resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_requested_resource_request import PatchedRequestedResourceRequest # (1)
from waldur_api_client.api.proposal_proposals import proposal_proposals_resources_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedRequestedResourceRequest()
response = proposal_proposals_resources_partial_update.sync(
    obj_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    uuid="string-value",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedRequestedResourceRequest
  2. API Source: proposal_proposals_resources_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { proposalProposalsResourcesPartialUpdate } from 'waldur-js-client';

try {
  const response = await proposalProposalsResourcesPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "obj_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "uuid": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
obj_uuid string ✓
uuid string ✓
Field Type Required
attributes any
limits any
description string
requested_offering_uuid string (uuid)
call_resource_template_uuid string (uuid)

200 -

Field Type
uuid string (uuid)
url string
requested_offering any
resource string (uri)
resource_name string
call_resource_template string
call_resource_template_name string
attributes any
limits any
description string
created_by string (uri)
created_by_name string

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/proposal-proposals/string-value/resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.proposal_proposals import proposal_proposals_resources_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = proposal_proposals_resources_destroy.sync(
    obj_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    uuid="string-value",
    client=client
)

print(response)
  1. API Source: proposal_proposals_resources_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { proposalProposalsResourcesDestroy } from 'waldur-js-client';

try {
  const response = await proposalProposalsResourcesDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "obj_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "uuid": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
obj_uuid string ✓
uuid string ✓

204 - No response body

Proposal Requested Offerings

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/proposal-requested-offerings/ List Proposal Requested Offerings
GET /api/proposal-requested-offerings/{uuid}/ Retrieve
Other Actions
POST /api/proposal-requested-offerings/{uuid}/accept/ Accept a requested offering
POST /api/proposal-requested-offerings/{uuid}/cancel/ Cancel a requested offering

Core CRUD

List Proposal Requested Offerings

1
2
3
4
http \
  GET \
  https://api.example.com/api/proposal-requested-offerings/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.provider_requested_offering_o_enum import ProviderRequestedOfferingOEnum # (1)
from waldur_api_client.models.requested_offering_states import RequestedOfferingStates # (2)
from waldur_api_client.api.proposal_requested_offerings import proposal_requested_offerings_list # (3)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = proposal_requested_offerings_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: ProviderRequestedOfferingOEnum
  2. Model Source: RequestedOfferingStates
  3. API Source: proposal_requested_offerings_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { proposalRequestedOfferingsList } from 'waldur-js-client';

try {
  const response = await proposalRequestedOfferingsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
call string (uri) Call
call_uuid string (uuid)
o array Ordering
offering string (uri) Offering
offering_uuid string (uuid)
organization_uuid string (uuid)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
provider_uuid string (uuid) Provider
state array

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid)
state any
offering string (uri)
offering_name string
offering_uuid string (uuid)
provider_name string
category_uuid string (uuid)
category_name string
call_managing_organisation string
attributes any
plan string (uri)
plan_details any
options any
components array of objects
components.uuid string (uuid)
components.billing_type string
Enum: fixed, usage, limit, one, few
components.type string Unique internal name of the measured unit, for example floating_ip.
components.name string Display name for the measured unit, for example, Floating IP.
components.description string
components.measured_unit string Unit of measurement, for example, GB.
components.unit_factor integer The conversion factor from backend units to measured_unit
components.limit_period any
components.limit_amount integer
components.article_code string
components.max_value integer
components.min_value integer
components.max_available_limit integer
components.is_boolean boolean
components.default_limit integer
components.factor integer
components.is_builtin boolean
components.is_prepaid boolean
components.overage_component string (uuid)
components.min_prepaid_duration integer
components.max_prepaid_duration integer
created string (date-time)
url string (uri)
call_name string
call string (uri)
description string
created_by_name string
created_by_email string (email)

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/proposal-requested-offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.proposal_requested_offerings import proposal_requested_offerings_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = proposal_requested_offerings_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: proposal_requested_offerings_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { proposalRequestedOfferingsRetrieve } from 'waldur-js-client';

try {
  const response = await proposalRequestedOfferingsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
uuid string (uuid)
state any
offering string (uri)
offering_name string
offering_uuid string (uuid)
provider_name string
category_uuid string (uuid)
category_name string
call_managing_organisation string
attributes any
plan string (uri)
plan_details any
options any
components array of objects
components.uuid string (uuid)
components.billing_type string
Enum: fixed, usage, limit, one, few
components.type string Unique internal name of the measured unit, for example floating_ip.
components.name string Display name for the measured unit, for example, Floating IP.
components.description string
components.measured_unit string Unit of measurement, for example, GB.
components.unit_factor integer The conversion factor from backend units to measured_unit
components.limit_period any
components.limit_amount integer
components.article_code string
components.max_value integer
components.min_value integer
components.max_available_limit integer
components.is_boolean boolean
components.default_limit integer
components.factor integer
components.is_builtin boolean
components.is_prepaid boolean
components.overage_component string (uuid)
components.min_prepaid_duration integer
components.max_prepaid_duration integer
created string (date-time)
url string (uri)
call_name string
call string (uri)
description string
created_by_name string
created_by_email string (email)

Other Actions

Accept a requested offering

Accept a requested offering.

1
2
3
4
http \
  POST \
  https://api.example.com/api/proposal-requested-offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/accept/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.proposal_requested_offerings import proposal_requested_offerings_accept # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = proposal_requested_offerings_accept.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: proposal_requested_offerings_accept
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { proposalRequestedOfferingsAccept } from 'waldur-js-client';

try {
  const response = await proposalRequestedOfferingsAccept({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 - No response body

Cancel a requested offering

Cancel a requested offering.

1
2
3
4
http \
  POST \
  https://api.example.com/api/proposal-requested-offerings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/cancel/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.proposal_requested_offerings import proposal_requested_offerings_cancel # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = proposal_requested_offerings_cancel.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: proposal_requested_offerings_cancel
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { proposalRequestedOfferingsCancel } from 'waldur-js-client';

try {
  const response = await proposalRequestedOfferingsCancel({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 - No response body

Proposal Requested Resources

Operations Summary

Method Endpoint Description
GET /api/proposal-requested-resources/ List Proposal Requested Resources
GET /api/proposal-requested-resources/{uuid}/ Retrieve

List Proposal Requested Resources

1
2
3
4
http \
  GET \
  https://api.example.com/api/proposal-requested-resources/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.provider_requested_resource_o_enum import ProviderRequestedResourceOEnum # (1)
from waldur_api_client.api.proposal_requested_resources import proposal_requested_resources_list # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = proposal_requested_resources_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: ProviderRequestedResourceOEnum
  2. API Source: proposal_requested_resources_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { proposalRequestedResourcesList } from 'waldur-js-client';

try {
  const response = await proposalRequestedResourcesList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
created string (date-time)
o array Ordering
offering string (uri) Offering
offering_uuid string (uuid)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
proposal string (uri) Proposal
proposal_uuid string (uuid)
resource string (uri) Resource
resource_uuid string (uuid)

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
uuid string (uuid)
url string
requested_offering any
resource string (uri)
resource_name string
call_resource_template string
call_resource_template_name string
attributes any
limits any
description string
created_by string (uri)
created_by_name string
proposal_name string
proposal string (uri)

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/proposal-requested-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.proposal_requested_resources import proposal_requested_resources_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = proposal_requested_resources_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: proposal_requested_resources_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { proposalRequestedResourcesRetrieve } from 'waldur-js-client';

try {
  const response = await proposalRequestedResourcesRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
uuid string (uuid)
url string
requested_offering any
resource string (uri)
resource_name string
call_resource_template string
call_resource_template_name string
attributes any
limits any
description string
created_by string (uri)
created_by_name string
proposal_name string
proposal string (uri)

Reviews

Coi Detection Jobs

Operations Summary

Method Endpoint Description
GET /api/coi-detection-jobs/ List Coi Detection Jobs
GET /api/coi-detection-jobs/{uuid}/ Retrieve

List Coi Detection Jobs

1
2
3
4
http \
  GET \
  https://api.example.com/api/coi-detection-jobs/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.coi_detection_job_job_type_enum import COIDetectionJobJobTypeEnum # (1)
from waldur_api_client.models.coi_detection_job_o_enum import COIDetectionJobOEnum # (2)
from waldur_api_client.models.coi_detection_job_state_enum import COIDetectionJobStateEnum # (3)
from waldur_api_client.api.coi_detection_jobs import coi_detection_jobs_list # (4)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = coi_detection_jobs_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: COIDetectionJobJobTypeEnum
  2. Model Source: COIDetectionJobOEnum
  3. Model Source: COIDetectionJobStateEnum
  4. API Source: coi_detection_jobs_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { coiDetectionJobsList } from 'waldur-js-client';

try {
  const response = await coiDetectionJobsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
call_uuid string (uuid)
job_type string Enum: full_call, incremental, single_pair
o array Ordering
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
state array

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string Return URL for the job detail endpoint.
uuid string (uuid)
call string (uri)
call_uuid string (uuid)
call_name string
job_type any
state any
total_pairs integer
processed_pairs integer
progress_percentage number (double)
conflicts_found integer
started_at string (date-time)
completed_at string (date-time)
error_message string
created string (date-time)

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/coi-detection-jobs/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.coi_detection_jobs import coi_detection_jobs_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = coi_detection_jobs_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: coi_detection_jobs_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { coiDetectionJobsRetrieve } from 'waldur-js-client';

try {
  const response = await coiDetectionJobsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
url string Return URL for the job detail endpoint.
uuid string (uuid)
call string (uri)
call_uuid string (uuid)
call_name string
job_type any
state any
total_pairs integer
processed_pairs integer
progress_percentage number (double)
conflicts_found integer
started_at string (date-time)
completed_at string (date-time)
error_message string
created string (date-time)

Coi Disclosures

Operations Summary

Method Endpoint Description
GET /api/coi-disclosures/ List Coi Disclosures
GET /api/coi-disclosures/{uuid}/ Retrieve
POST /api/coi-disclosures/ Create

List Coi Disclosures

1
2
3
4
http \
  GET \
  https://api.example.com/api/coi-disclosures/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.coi_disclosure_form_o_enum import COIDisclosureFormOEnum # (1)
from waldur_api_client.api.coi_disclosures import coi_disclosures_list # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = coi_disclosures_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: COIDisclosureFormOEnum
  2. API Source: coi_disclosures_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { coiDisclosuresList } from 'waldur-js-client';

try {
  const response = await coiDisclosuresList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
call_uuid string (uuid)
certified boolean
is_current boolean
o array Ordering
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
reviewer_uuid string (uuid)

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
reviewer string (uri)
reviewer_uuid string (uuid)
reviewer_name string
call string (uri) Null for general annual disclosure
call_uuid string (uuid)
call_name string
certified boolean
certification_date string (date-time)
certification_statement string Legal text they agreed to
has_financial_interests boolean
financial_interests array of objects
financial_interests.uuid string (uuid)
financial_interests.entity_name string
financial_interests.entity_type string
Enum: company, startup, nonprofit, government, other
financial_interests.relationship_type string
Enum: employment, consulting, equity, board, royalties, gifts, other
financial_interests.amount_range string
Enum: none, under_5k, 5k_10k, 10k_50k, over_50k
financial_interests.is_ongoing boolean
financial_interests.description string
has_personal_relationships boolean
personal_relationships any
has_other_conflicts boolean
other_conflicts_description string
valid_until string (date) Typically 1 year from certification
is_current boolean
created string (date-time)

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/coi-disclosures/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.coi_disclosures import coi_disclosures_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = coi_disclosures_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: coi_disclosures_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { coiDisclosuresRetrieve } from 'waldur-js-client';

try {
  const response = await coiDisclosuresRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
url string (uri)
uuid string (uuid)
reviewer string (uri)
reviewer_uuid string (uuid)
reviewer_name string
call string (uri) Null for general annual disclosure
call_uuid string (uuid)
call_name string
certified boolean
certification_date string (date-time)
certification_statement string Legal text they agreed to
has_financial_interests boolean
financial_interests array of objects
financial_interests.uuid string (uuid)
financial_interests.entity_name string
financial_interests.entity_type string
Enum: company, startup, nonprofit, government, other
financial_interests.relationship_type string
Enum: employment, consulting, equity, board, royalties, gifts, other
financial_interests.amount_range string
Enum: none, under_5k, 5k_10k, 10k_50k, over_50k
financial_interests.is_ongoing boolean
financial_interests.description string
has_personal_relationships boolean
personal_relationships any
has_other_conflicts boolean
other_conflicts_description string
valid_until string (date) Typically 1 year from certification
is_current boolean
created string (date-time)

Create

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/coi-disclosures/ \
  Authorization:"Token YOUR_API_TOKEN" \
  valid_until="2023-10-01"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.coi_disclosure_form_request import COIDisclosureFormRequest # (1)
from waldur_api_client.api.coi_disclosures import coi_disclosures_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = COIDisclosureFormRequest(
    valid_until="2023-10-01"
)
response = coi_disclosures_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: COIDisclosureFormRequest
  2. API Source: coi_disclosures_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { coiDisclosuresCreate } from 'waldur-js-client';

try {
  const response = await coiDisclosuresCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "valid_until": "2023-10-01"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
call string (uri) Null for general annual disclosure
certified boolean
certification_statement string Legal text they agreed to
has_financial_interests boolean
has_personal_relationships boolean
personal_relationships any
has_other_conflicts boolean
other_conflicts_description string
valid_until string (date) ✓ Typically 1 year from certification

201 -

Field Type Description
url string (uri)
uuid string (uuid)
reviewer string (uri)
reviewer_uuid string (uuid)
reviewer_name string
call string (uri) Null for general annual disclosure
call_uuid string (uuid)
call_name string
certified boolean
certification_date string (date-time)
certification_statement string Legal text they agreed to
has_financial_interests boolean
financial_interests array of objects
financial_interests.uuid string (uuid)
financial_interests.entity_name string
financial_interests.entity_type string
Enum: company, startup, nonprofit, government, other
financial_interests.relationship_type string
Enum: employment, consulting, equity, board, royalties, gifts, other
financial_interests.amount_range string
Enum: none, under_5k, 5k_10k, 10k_50k, over_50k
financial_interests.is_ongoing boolean
financial_interests.description string
has_personal_relationships boolean
personal_relationships any
has_other_conflicts boolean
other_conflicts_description string
valid_until string (date) Typically 1 year from certification
is_current boolean
created string (date-time)

Conflicts Of Interest

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/conflicts-of-interest/ List Conflicts Of Interest
GET /api/conflicts-of-interest/{uuid}/ Retrieve
PUT /api/conflicts-of-interest/{uuid}/ Update
PATCH /api/conflicts-of-interest/{uuid}/ Partial Update
Other Actions
POST /api/conflicts-of-interest/{uuid}/dismiss/ Dismiss a conflict of interest (not a real conflict)
POST /api/conflicts-of-interest/{uuid}/recuse/ Recuse reviewer from the proposal
POST /api/conflicts-of-interest/{uuid}/waive/ Waive a conflict with a management plan

Core CRUD

List Conflicts Of Interest

1
2
3
4
http \
  GET \
  https://api.example.com/api/conflicts-of-interest/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.coi_severity_level import COISeverityLevel # (1)
from waldur_api_client.models.coi_type_enum import CoiTypeEnum # (2)
from waldur_api_client.models.conflict_of_interest_o_enum import ConflictOfInterestOEnum # (3)
from waldur_api_client.models.conflict_of_interest_status_enum import ConflictOfInterestStatusEnum # (4)
from waldur_api_client.models.detection_method_enum import DetectionMethodEnum # (5)
from waldur_api_client.api.conflicts_of_interest import conflicts_of_interest_list # (6)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = conflicts_of_interest_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: COISeverityLevel
  2. Model Source: CoiTypeEnum
  3. Model Source: ConflictOfInterestOEnum
  4. Model Source: ConflictOfInterestStatusEnum
  5. Model Source: DetectionMethodEnum
  6. API Source: conflicts_of_interest_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { conflictsOfInterestList } from 'waldur-js-client';

try {
  const response = await conflictsOfInterestList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
call_uuid string (uuid)
coi_type array
detection_method array
o array Ordering
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
proposal_uuid string (uuid)
reviewer_name string
reviewer_uuid string (uuid)
round_uuid string (uuid)
severity string Enum: real, apparent, potential
status array

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
reviewer string (uri)
reviewer_uuid string (uuid)
reviewer_name string
proposal string (uri)
proposal_uuid string (uuid)
proposal_name string
round_uuid string (uuid)
round_name string
call string (uri)
call_uuid string (uuid)
call_name string
coi_type any
coi_type_display string
severity any
severity_display string
detection_method any
detected_at string (date-time)
evidence_description string
evidence_data any Structured evidence: {"papers": [...], "affiliation_overlap": {...}}
status string
Enum: pending, dismissed, waived, recused
status_display string
reviewed_by string (uri)
reviewed_by_name string
reviewed_at string (date-time)
review_notes string
management_plan string If waived, how is it managed
conflicting_user string (uri) Specific person causing conflict
conflicting_user_name string
conflicting_organization string (uri)
conflicting_organization_name string
created string (date-time)

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/conflicts-of-interest/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.conflicts_of_interest import conflicts_of_interest_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = conflicts_of_interest_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: conflicts_of_interest_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { conflictsOfInterestRetrieve } from 'waldur-js-client';

try {
  const response = await conflictsOfInterestRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
url string (uri)
uuid string (uuid)
reviewer string (uri)
reviewer_uuid string (uuid)
reviewer_name string
proposal string (uri)
proposal_uuid string (uuid)
proposal_name string
round_uuid string (uuid)
round_name string
call string (uri)
call_uuid string (uuid)
call_name string
coi_type any
coi_type_display string
severity any
severity_display string
detection_method any
detected_at string (date-time)
evidence_description string
evidence_data any Structured evidence: {"papers": [...], "affiliation_overlap": {...}}
status string
Enum: pending, dismissed, waived, recused
status_display string
reviewed_by string (uri)
reviewed_by_name string
reviewed_at string (date-time)
review_notes string
management_plan string If waived, how is it managed
conflicting_user string (uri) Specific person causing conflict
conflicting_user_name string
conflicting_organization string (uri)
conflicting_organization_name string
created string (date-time)

Update

1
2
3
4
http \
  PUT \
  https://api.example.com/api/conflicts-of-interest/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.conflict_of_interest_request import ConflictOfInterestRequest # (1)
from waldur_api_client.api.conflicts_of_interest import conflicts_of_interest_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ConflictOfInterestRequest()
response = conflicts_of_interest_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ConflictOfInterestRequest
  2. API Source: conflicts_of_interest_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { conflictsOfInterestUpdate } from 'waldur-js-client';

try {
  const response = await conflictsOfInterestUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
status string
Enum: pending, dismissed, waived, recused
review_notes string
management_plan string If waived, how is it managed

200 -

Field Type Description
url string (uri)
uuid string (uuid)
reviewer string (uri)
reviewer_uuid string (uuid)
reviewer_name string
proposal string (uri)
proposal_uuid string (uuid)
proposal_name string
round_uuid string (uuid)
round_name string
call string (uri)
call_uuid string (uuid)
call_name string
coi_type any
coi_type_display string
severity any
severity_display string
detection_method any
detected_at string (date-time)
evidence_description string
evidence_data any Structured evidence: {"papers": [...], "affiliation_overlap": {...}}
status string
Enum: pending, dismissed, waived, recused
status_display string
reviewed_by string (uri)
reviewed_by_name string
reviewed_at string (date-time)
review_notes string
management_plan string If waived, how is it managed
conflicting_user string (uri) Specific person causing conflict
conflicting_user_name string
conflicting_organization string (uri)
conflicting_organization_name string
created string (date-time)

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/conflicts-of-interest/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_conflict_of_interest_request import PatchedConflictOfInterestRequest # (1)
from waldur_api_client.api.conflicts_of_interest import conflicts_of_interest_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedConflictOfInterestRequest()
response = conflicts_of_interest_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedConflictOfInterestRequest
  2. API Source: conflicts_of_interest_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { conflictsOfInterestPartialUpdate } from 'waldur-js-client';

try {
  const response = await conflictsOfInterestPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
status string
Enum: pending, dismissed, waived, recused
review_notes string
management_plan string If waived, how is it managed

200 -

Field Type Description
url string (uri)
uuid string (uuid)
reviewer string (uri)
reviewer_uuid string (uuid)
reviewer_name string
proposal string (uri)
proposal_uuid string (uuid)
proposal_name string
round_uuid string (uuid)
round_name string
call string (uri)
call_uuid string (uuid)
call_name string
coi_type any
coi_type_display string
severity any
severity_display string
detection_method any
detected_at string (date-time)
evidence_description string
evidence_data any Structured evidence: {"papers": [...], "affiliation_overlap": {...}}
status string
Enum: pending, dismissed, waived, recused
status_display string
reviewed_by string (uri)
reviewed_by_name string
reviewed_at string (date-time)
review_notes string
management_plan string If waived, how is it managed
conflicting_user string (uri) Specific person causing conflict
conflicting_user_name string
conflicting_organization string (uri)
conflicting_organization_name string
created string (date-time)

Other Actions

Dismiss a conflict of interest (not a real conflict)

Dismiss a conflict of interest (not a real conflict).

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/conflicts-of-interest/a1b2c3d4-e5f6-7890-abcd-ef1234567890/dismiss/ \
  Authorization:"Token YOUR_API_TOKEN" \
  status="dismissed"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.coi_status_update_request import COIStatusUpdateRequest # (1)
from waldur_api_client.api.conflicts_of_interest import conflicts_of_interest_dismiss # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = COIStatusUpdateRequest(
    status="dismissed"
)
response = conflicts_of_interest_dismiss.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: COIStatusUpdateRequest
  2. API Source: conflicts_of_interest_dismiss
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { conflictsOfInterestDismiss } from 'waldur-js-client';

try {
  const response = await conflictsOfInterestDismiss({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "status": "dismissed"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
status string ✓
Enum: dismissed, waived, recused
review_notes string
management_plan string Required when status is 'waived'

200 -

Field Type Description
url string (uri)
uuid string (uuid)
reviewer string (uri)
reviewer_uuid string (uuid)
reviewer_name string
proposal string (uri)
proposal_uuid string (uuid)
proposal_name string
round_uuid string (uuid)
round_name string
call string (uri)
call_uuid string (uuid)
call_name string
coi_type any
coi_type_display string
severity any
severity_display string
detection_method any
detected_at string (date-time)
evidence_description string
evidence_data any Structured evidence: {"papers": [...], "affiliation_overlap": {...}}
status string
Enum: pending, dismissed, waived, recused
status_display string
reviewed_by string (uri)
reviewed_by_name string
reviewed_at string (date-time)
review_notes string
management_plan string If waived, how is it managed
conflicting_user string (uri) Specific person causing conflict
conflicting_user_name string
conflicting_organization string (uri)
conflicting_organization_name string
created string (date-time)

Recuse reviewer from the proposal

Recuse reviewer from the proposal.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/conflicts-of-interest/a1b2c3d4-e5f6-7890-abcd-ef1234567890/recuse/ \
  Authorization:"Token YOUR_API_TOKEN" \
  status="dismissed"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.coi_status_update_request import COIStatusUpdateRequest # (1)
from waldur_api_client.api.conflicts_of_interest import conflicts_of_interest_recuse # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = COIStatusUpdateRequest(
    status="dismissed"
)
response = conflicts_of_interest_recuse.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: COIStatusUpdateRequest
  2. API Source: conflicts_of_interest_recuse
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { conflictsOfInterestRecuse } from 'waldur-js-client';

try {
  const response = await conflictsOfInterestRecuse({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "status": "dismissed"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
status string ✓
Enum: dismissed, waived, recused
review_notes string
management_plan string Required when status is 'waived'

200 -

Field Type Description
url string (uri)
uuid string (uuid)
reviewer string (uri)
reviewer_uuid string (uuid)
reviewer_name string
proposal string (uri)
proposal_uuid string (uuid)
proposal_name string
round_uuid string (uuid)
round_name string
call string (uri)
call_uuid string (uuid)
call_name string
coi_type any
coi_type_display string
severity any
severity_display string
detection_method any
detected_at string (date-time)
evidence_description string
evidence_data any Structured evidence: {"papers": [...], "affiliation_overlap": {...}}
status string
Enum: pending, dismissed, waived, recused
status_display string
reviewed_by string (uri)
reviewed_by_name string
reviewed_at string (date-time)
review_notes string
management_plan string If waived, how is it managed
conflicting_user string (uri) Specific person causing conflict
conflicting_user_name string
conflicting_organization string (uri)
conflicting_organization_name string
created string (date-time)

Waive a conflict with a management plan

Waive a conflict with a management plan.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/conflicts-of-interest/a1b2c3d4-e5f6-7890-abcd-ef1234567890/waive/ \
  Authorization:"Token YOUR_API_TOKEN" \
  status="dismissed"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.coi_status_update_request import COIStatusUpdateRequest # (1)
from waldur_api_client.api.conflicts_of_interest import conflicts_of_interest_waive # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = COIStatusUpdateRequest(
    status="dismissed"
)
response = conflicts_of_interest_waive.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: COIStatusUpdateRequest
  2. API Source: conflicts_of_interest_waive
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { conflictsOfInterestWaive } from 'waldur-js-client';

try {
  const response = await conflictsOfInterestWaive({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "status": "dismissed"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
status string ✓
Enum: dismissed, waived, recused
review_notes string
management_plan string Required when status is 'waived'

200 -

Field Type Description
url string (uri)
uuid string (uuid)
reviewer string (uri)
reviewer_uuid string (uuid)
reviewer_name string
proposal string (uri)
proposal_uuid string (uuid)
proposal_name string
round_uuid string (uuid)
round_name string
call string (uri)
call_uuid string (uuid)
call_name string
coi_type any
coi_type_display string
severity any
severity_display string
detection_method any
detected_at string (date-time)
evidence_description string
evidence_data any Structured evidence: {"papers": [...], "affiliation_overlap": {...}}
status string
Enum: pending, dismissed, waived, recused
status_display string
reviewed_by string (uri)
reviewed_by_name string
reviewed_at string (date-time)
review_notes string
management_plan string If waived, how is it managed
conflicting_user string (uri) Specific person causing conflict
conflicting_user_name string
conflicting_organization string (uri)
conflicting_organization_name string
created string (date-time)

Expertise Categories

Operations Summary

Method Endpoint Description
GET /api/expertise-categories/ List Expertise Categories
GET /api/expertise-categories/{uuid}/ Retrieve

List Expertise Categories

1
2
3
4
http \
  GET \
  https://api.example.com/api/expertise-categories/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.expertise_category_o_enum import ExpertiseCategoryOEnum # (1)
from waldur_api_client.api.expertise_categories import expertise_categories_list # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = expertise_categories_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: ExpertiseCategoryOEnum
  2. API Source: expertise_categories_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { expertiseCategoriesList } from 'waldur-js-client';

try {
  const response = await expertiseCategoriesList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
code string
level integer
name string
o array Ordering
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
parent_uuid string (uuid)

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
name string
code string
description string
parent string (uri)
level integer Depth in hierarchy (0 = root)

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/expertise-categories/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.expertise_categories import expertise_categories_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = expertise_categories_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: expertise_categories_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { expertiseCategoriesRetrieve } from 'waldur-js-client';

try {
  const response = await expertiseCategoriesRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
code string
description string
parent string (uri)
level integer Depth in hierarchy (0 = root)

Reviewer Bids

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/reviewer-bids/ List Reviewer Bids
GET /api/reviewer-bids/{uuid}/ Retrieve
POST /api/reviewer-bids/ Create
PUT /api/reviewer-bids/{uuid}/ Update
PATCH /api/reviewer-bids/{uuid}/ Partial Update
DELETE /api/reviewer-bids/{uuid}/ Delete
Other Actions
GET /api/reviewer-bids/my-bids/ Get my bids for a specific call
POST /api/reviewer-bids/bulk-submit/ Submit multiple bids at once
POST /api/reviewer-bids/submit/ Submit a bid on a proposal

Core CRUD

List Reviewer Bids

1
2
3
4
http \
  GET \
  https://api.example.com/api/reviewer-bids/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.bid_enum import BidEnum # (1)
from waldur_api_client.models.reviewer_bid_o_enum import ReviewerBidOEnum # (2)
from waldur_api_client.api.reviewer_bids import reviewer_bids_list # (3)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = reviewer_bids_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: BidEnum
  2. Model Source: ReviewerBidOEnum
  3. API Source: reviewer_bids_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { reviewerBidsList } from 'waldur-js-client';

try {
  const response = await reviewerBidsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
bid array Reviewer's preference for reviewing this proposal
call_uuid string (uuid)
o array Ordering
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
proposal_uuid string (uuid)
reviewer_uuid string (uuid)

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid)
call string (uri)
call_uuid string (uuid)
reviewer string (uri)
reviewer_uuid string (uuid)
reviewer_name string
proposal string (uri)
proposal_uuid string (uuid)
proposal_name string
bid any Reviewer's preference for reviewing this proposal
bid_display string
comment string Optional comment explaining the bid
submitted_at string (date-time)
modified_at string (date-time)

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/reviewer-bids/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.reviewer_bids import reviewer_bids_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = reviewer_bids_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: reviewer_bids_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { reviewerBidsRetrieve } from 'waldur-js-client';

try {
  const response = await reviewerBidsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
uuid string (uuid)
call string (uri)
call_uuid string (uuid)
reviewer string (uri)
reviewer_uuid string (uuid)
reviewer_name string
proposal string (uri)
proposal_uuid string (uuid)
proposal_name string
bid any Reviewer's preference for reviewing this proposal
bid_display string
comment string Optional comment explaining the bid
submitted_at string (date-time)
modified_at string (date-time)

Create

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/reviewer-bids/ \
  Authorization:"Token YOUR_API_TOKEN" \
  proposal="https://api.example.com/api/proposal/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  bid=null

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.reviewer_bid_request import ReviewerBidRequest # (1)
from waldur_api_client.api.reviewer_bids import reviewer_bids_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ReviewerBidRequest(
    proposal="https://api.example.com/api/proposal/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    bid=null
)
response = reviewer_bids_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ReviewerBidRequest
  2. API Source: reviewer_bids_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { reviewerBidsCreate } from 'waldur-js-client';

try {
  const response = await reviewerBidsCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "proposal": "https://api.example.com/api/proposal/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "bid": null
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
proposal string (uri) ✓
bid any ✓ Reviewer's preference for reviewing this proposal
comment string Optional comment explaining the bid

201 -

Field Type Description
uuid string (uuid)
call string (uri)
call_uuid string (uuid)
reviewer string (uri)
reviewer_uuid string (uuid)
reviewer_name string
proposal string (uri)
proposal_uuid string (uuid)
proposal_name string
bid any Reviewer's preference for reviewing this proposal
bid_display string
comment string Optional comment explaining the bid
submitted_at string (date-time)
modified_at string (date-time)

Update

1
2
3
4
5
6
http \
  PUT \
  https://api.example.com/api/reviewer-bids/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  proposal="https://api.example.com/api/proposal/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  bid=null

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.reviewer_bid_request import ReviewerBidRequest # (1)
from waldur_api_client.api.reviewer_bids import reviewer_bids_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ReviewerBidRequest(
    proposal="https://api.example.com/api/proposal/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    bid=null
)
response = reviewer_bids_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ReviewerBidRequest
  2. API Source: reviewer_bids_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { reviewerBidsUpdate } from 'waldur-js-client';

try {
  const response = await reviewerBidsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "proposal": "https://api.example.com/api/proposal/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "bid": null
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
proposal string (uri) ✓
bid any ✓ Reviewer's preference for reviewing this proposal
comment string Optional comment explaining the bid

200 -

Field Type Description
uuid string (uuid)
call string (uri)
call_uuid string (uuid)
reviewer string (uri)
reviewer_uuid string (uuid)
reviewer_name string
proposal string (uri)
proposal_uuid string (uuid)
proposal_name string
bid any Reviewer's preference for reviewing this proposal
bid_display string
comment string Optional comment explaining the bid
submitted_at string (date-time)
modified_at string (date-time)

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/reviewer-bids/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_reviewer_bid_request import PatchedReviewerBidRequest # (1)
from waldur_api_client.api.reviewer_bids import reviewer_bids_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedReviewerBidRequest()
response = reviewer_bids_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedReviewerBidRequest
  2. API Source: reviewer_bids_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { reviewerBidsPartialUpdate } from 'waldur-js-client';

try {
  const response = await reviewerBidsPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
proposal string (uri)
bid any Reviewer's preference for reviewing this proposal
comment string Optional comment explaining the bid

200 -

Field Type Description
uuid string (uuid)
call string (uri)
call_uuid string (uuid)
reviewer string (uri)
reviewer_uuid string (uuid)
reviewer_name string
proposal string (uri)
proposal_uuid string (uuid)
proposal_name string
bid any Reviewer's preference for reviewing this proposal
bid_display string
comment string Optional comment explaining the bid
submitted_at string (date-time)
modified_at string (date-time)

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/reviewer-bids/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.reviewer_bids import reviewer_bids_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = reviewer_bids_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: reviewer_bids_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { reviewerBidsDestroy } from 'waldur-js-client';

try {
  const response = await reviewerBidsDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Other Actions

Get my bids for a specific call

Get my bids for a specific call.

1
2
3
4
http \
  GET \
  https://api.example.com/api/reviewer-bids/my-bids/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.bid_enum import BidEnum # (1)
from waldur_api_client.models.reviewer_bid_o_enum import ReviewerBidOEnum # (2)
from waldur_api_client.api.reviewer_bids import reviewer_bids_my_bids_list # (3)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = reviewer_bids_my_bids_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: BidEnum
  2. Model Source: ReviewerBidOEnum
  3. API Source: reviewer_bids_my_bids_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { reviewerBidsMyBidsList } from 'waldur-js-client';

try {
  const response = await reviewerBidsMyBidsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
bid array Reviewer's preference for reviewing this proposal
call_uuid string (uuid)
o array Ordering
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
proposal_uuid string (uuid)
reviewer_uuid string (uuid)

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid)
call string (uri)
call_uuid string (uuid)
reviewer string (uri)
reviewer_uuid string (uuid)
reviewer_name string
proposal string (uri)
proposal_uuid string (uuid)
proposal_name string
bid any Reviewer's preference for reviewing this proposal
bid_display string
comment string Optional comment explaining the bid
submitted_at string (date-time)
modified_at string (date-time)

Submit multiple bids at once

Submit multiple bids at once.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/reviewer-bids/bulk-submit/ \
  Authorization:"Token YOUR_API_TOKEN" \
  bids:='[]'

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.reviewer_bulk_bid_request import ReviewerBulkBidRequest # (1)
from waldur_api_client.api.reviewer_bids import reviewer_bids_bulk_submit # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ReviewerBulkBidRequest(
    bids=[]
)
response = reviewer_bids_bulk_submit.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ReviewerBulkBidRequest
  2. API Source: reviewer_bids_bulk_submit
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { reviewerBidsBulkSubmit } from 'waldur-js-client';

try {
  const response = await reviewerBidsBulkSubmit({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "bids": []
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required
bids array of objects ✓
bids.proposal_uuid string (uuid) ✓
bids.bid string ✓
bids.comment string

200 -

Field Type
submitted integer

Submit a bid on a proposal

Submit a bid on a proposal.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/reviewer-bids/submit/ \
  Authorization:"Token YOUR_API_TOKEN" \
  proposal_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  bid="eager"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.reviewer_bid_submit_request import ReviewerBidSubmitRequest # (1)
from waldur_api_client.api.reviewer_bids import reviewer_bids_submit # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ReviewerBidSubmitRequest(
    proposal_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    bid="eager"
)
response = reviewer_bids_submit.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ReviewerBidSubmitRequest
  2. API Source: reviewer_bids_submit
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { reviewerBidsSubmit } from 'waldur-js-client';

try {
  const response = await reviewerBidsSubmit({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "proposal_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "bid": "eager"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required
proposal_uuid string (uuid) ✓
bid string ✓
comment string

200 -

Field Type Description
uuid string (uuid)
call string (uri)
call_uuid string (uuid)
reviewer string (uri)
reviewer_uuid string (uuid)
reviewer_name string
proposal string (uri)
proposal_uuid string (uuid)
proposal_name string
bid any Reviewer's preference for reviewing this proposal
bid_display string
comment string Optional comment explaining the bid
submitted_at string (date-time)
modified_at string (date-time)

Reviewer Invitations

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/reviewer-invitations/{token}/ Get invitation details by token
Other Actions
POST /api/reviewer-invitations/{token}/accept/ Accept a reviewer invitation
POST /api/reviewer-invitations/{token}/decline/ Decline a reviewer invitation

Core CRUD

Get invitation details by token

Get invitation details by token.

1
2
3
4
http \
  GET \
  https://api.example.com/api/reviewer-invitations/********/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.reviewer_invitations import reviewer_invitations_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = reviewer_invitations_retrieve.sync(
    token="********",
    client=client
)

print(response)
  1. API Source: reviewer_invitations_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { reviewerInvitationsRetrieve } from 'waldur-js-client';

try {
  const response = await reviewerInvitationsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "token": "********"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
token string ✓

200 -

Field Type Description
call_name string
call_uuid string (uuid)
invitation_status string
expires_at string (date-time)
is_expired boolean
max_assignments integer
invited_by_name string Name of the person who sent the invitation
profile_status string User's profile status: 'published', 'unpublished', 'missing', or null if not authenticated
requires_profile boolean Whether the invitation requires creating a reviewer profile
coi_configuration any COI configuration for this call
coi_types array of arrays Available COI types as list of [value, label] tuples
proposals array of objects Proposals for which conflicts can be declared
proposals.uuid string (uuid)
proposals.name string
proposals.summary string

Other Actions

Accept a reviewer invitation

Accept a reviewer invitation.

1
2
3
4
http \
  POST \
  https://api.example.com/api/reviewer-invitations/********/accept/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.invitation_accept_request import InvitationAcceptRequest # (1)
from waldur_api_client.api.reviewer_invitations import reviewer_invitations_accept # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = InvitationAcceptRequest()
response = reviewer_invitations_accept.sync(
    token="********",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: InvitationAcceptRequest
  2. API Source: reviewer_invitations_accept
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { reviewerInvitationsAccept } from 'waldur-js-client';

try {
  const response = await reviewerInvitationsAccept({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "token": "********"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
token string ✓
Field Type Required Description
declared_conflicts array of objects Optional list of self-declared conflicts with proposals. Each conflict creates a ConflictOfInterest record with detection_method='self_disclosed'.
declared_conflicts.proposal_uuid string (uuid) ✓
declared_conflicts.coi_type string ✓
Enum: INST_SAME, FIN_DIRECT, REL_FAMILY, ROLE_NAMED, COLLAB_ACTIVE, REL_MENTOR, REL_SUPERVISOR, COAUTH_RECENT, INST_DEPT, INST_FORMER, ROLE_CONF, COLLAB_GRANT, REL_EDITORIAL, COMPET, COAUTH_OLD, INST_CONSORT, CONF_ATTEND, SOC_MEMBER
declared_conflicts.severity any
Constraints: default: apparent
declared_conflicts.description string
Constraints: default: ``

200 -

Field Type Description
detail string
declared_conflicts array of string (uuid)s UUIDs of created conflict records

400 -

Field Type
error string
message string
profile_url string

401 -

Field Type
error string

Decline a reviewer invitation

Decline a reviewer invitation.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/reviewer-invitations/********/decline/ \
  Authorization:"Token YOUR_API_TOKEN" \
  reason="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.invitation_decline_request import InvitationDeclineRequest # (1)
from waldur_api_client.api.reviewer_invitations import reviewer_invitations_decline # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = InvitationDeclineRequest(
    reason="string-value"
)
response = reviewer_invitations_decline.sync(
    token="********",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: InvitationDeclineRequest
  2. API Source: reviewer_invitations_decline
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { reviewerInvitationsDecline } from 'waldur-js-client';

try {
  const response = await reviewerInvitationsDecline({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "token": "********"
  },
  body: {
    "reason": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
token string ✓
Field Type Required Description
reason string ✓ Reason for declining the invitation

200 -

Field Type
detail string

Reviewer Profiles

Operations Summary

Method Endpoint Description
GET /api/reviewer-profiles/{reviewer_profile_uuid}/affiliations/ Affiliations
GET /api/reviewer-profiles/{reviewer_profile_uuid}/affiliations/{uuid}/ Retrieve
GET /api/reviewer-profiles/{reviewer_profile_uuid}/expertise/ Expertise
GET /api/reviewer-profiles/{reviewer_profile_uuid}/expertise/{uuid}/ Retrieve
GET /api/reviewer-profiles/{reviewer_profile_uuid}/publications/ Publications
GET /api/reviewer-profiles/{reviewer_profile_uuid}/publications/{uuid}/ Retrieve
GET /api/reviewer-profiles/{uuid}/affiliations/ List affiliations for a reviewer profile
GET /api/reviewer-profiles/{uuid}/connect-orcid/ Get ORCID OAuth authorization URL
GET /api/reviewer-profiles/{uuid}/expertise/ List expertise keywords for a reviewer profile
GET /api/reviewer-profiles/ List Reviewer Profiles
GET /api/reviewer-profiles/me/ Get or create reviewer profile for the current user
GET /api/reviewer-profiles/{uuid}/publications/ List publications for a reviewer profile
GET /api/reviewer-profiles/{uuid}/ Retrieve
POST /api/reviewer-profiles/{reviewer_profile_uuid}/affiliations/ Affiliations
POST /api/reviewer-profiles/{reviewer_profile_uuid}/expertise/ Expertise
POST /api/reviewer-profiles/{reviewer_profile_uuid}/publications/ Publications
POST /api/reviewer-profiles/{uuid}/affiliations/ Create affiliation for a reviewer profile
POST /api/reviewer-profiles/{uuid}/connect-orcid/callback/ Complete ORCID OAuth connection with authorization code
POST /api/reviewer-profiles/ Create
POST /api/reviewer-profiles/{uuid}/disconnect-orcid/ Disconnect ORCID from profile
POST /api/reviewer-profiles/{uuid}/expertise/ Create expertise entry for a reviewer profile
POST /api/reviewer-profiles/{uuid}/import-publications/ Import publications from ORCID or other sources
POST /api/reviewer-profiles/me/ Get or create reviewer profile for the current user
POST /api/reviewer-profiles/{uuid}/publications/ Create publication for a reviewer profile
POST /api/reviewer-profiles/publish/ Publish
POST /api/reviewer-profiles/{uuid}/sync-orcid/ Sync profile data from ORCID
POST /api/reviewer-profiles/unpublish/ Unpublish reviewer profile to remove it from discovery
PUT /api/reviewer-profiles/{reviewer_profile_uuid}/affiliations/{uuid}/ Update
PUT /api/reviewer-profiles/{reviewer_profile_uuid}/expertise/{uuid}/ Update
PUT /api/reviewer-profiles/{reviewer_profile_uuid}/publications/{uuid}/ Update
PUT /api/reviewer-profiles/{uuid}/ Update
PATCH /api/reviewer-profiles/{reviewer_profile_uuid}/affiliations/{uuid}/ Partial Update
PATCH /api/reviewer-profiles/{reviewer_profile_uuid}/expertise/{uuid}/ Partial Update
PATCH /api/reviewer-profiles/{reviewer_profile_uuid}/publications/{uuid}/ Partial Update
PATCH /api/reviewer-profiles/me/ Get or create reviewer profile for the current user
PATCH /api/reviewer-profiles/{uuid}/ Partial Update
DELETE /api/reviewer-profiles/{reviewer_profile_uuid}/affiliations/{uuid}/ Delete
DELETE /api/reviewer-profiles/{reviewer_profile_uuid}/expertise/{uuid}/ Delete
DELETE /api/reviewer-profiles/{reviewer_profile_uuid}/publications/{uuid}/ Delete
DELETE /api/reviewer-profiles/{uuid}/ Delete

Affiliations

1
2
3
4
http \
  GET \
  https://api.example.com/api/reviewer-profiles/a1b2c3d4-e5f6-7890-abcd-ef1234567890/affiliations/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.reviewer_profiles import nested_reviewer_profile_affiliations_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = nested_reviewer_profile_affiliations_list.sync(
    reviewer_profile_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

for item in response:
    print(item)
  1. API Source: nested_reviewer_profile_affiliations_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { nestedReviewerProfileAffiliationsList } from 'waldur-js-client';

try {
  const response = await nestedReviewerProfileAffiliationsList({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "reviewer_profile_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
reviewer_profile_uuid string ✓ UUID of the parent reviewer profile
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid)
organization string (uuid)
organization_name string Organization name (used when not linked to Waldur org)
organization_name_display string Return organization name from linked Customer or from the text field.
organization_identifier string ROR, GRID, or other external identifier
department string
position_title string
start_date string (date)
end_date string (date) Leave empty for current affiliation
is_primary boolean
affiliation_type string
Enum: employment, education, visiting, honorary, consulting
created string (date-time)

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/reviewer-profiles/a1b2c3d4-e5f6-7890-abcd-ef1234567890/affiliations/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.reviewer_profiles import nested_reviewer_profile_affiliations_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = nested_reviewer_profile_affiliations_retrieve.sync(
    reviewer_profile_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: nested_reviewer_profile_affiliations_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { nestedReviewerProfileAffiliationsRetrieve } from 'waldur-js-client';

try {
  const response = await nestedReviewerProfileAffiliationsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "reviewer_profile_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
reviewer_profile_uuid string ✓ UUID of the parent reviewer profile
uuid string (uuid) ✓

200 -

Field Type Description
uuid string (uuid)
organization string (uuid)
organization_name string Organization name (used when not linked to Waldur org)
organization_name_display string Return organization name from linked Customer or from the text field.
organization_identifier string ROR, GRID, or other external identifier
department string
position_title string
start_date string (date)
end_date string (date) Leave empty for current affiliation
is_primary boolean
affiliation_type string
Enum: employment, education, visiting, honorary, consulting
created string (date-time)

Expertise

1
2
3
4
http \
  GET \
  https://api.example.com/api/reviewer-profiles/a1b2c3d4-e5f6-7890-abcd-ef1234567890/expertise/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.reviewer_profiles import nested_reviewer_profile_expertise_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = nested_reviewer_profile_expertise_list.sync(
    reviewer_profile_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

for item in response:
    print(item)
  1. API Source: nested_reviewer_profile_expertise_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { nestedReviewerProfileExpertiseList } from 'waldur-js-client';

try {
  const response = await nestedReviewerProfileExpertiseList({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "reviewer_profile_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
reviewer_profile_uuid string ✓ UUID of the parent reviewer profile
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid)
expertise_keyword string Free-text keyword
expertise_category string (uuid)
expertise_category_name string
proficiency_level string
Enum: expert, familiar, basic
years_experience integer
last_active_date string (date) When last worked in this area
created string (date-time)

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/reviewer-profiles/a1b2c3d4-e5f6-7890-abcd-ef1234567890/expertise/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.reviewer_profiles import nested_reviewer_profile_expertise_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = nested_reviewer_profile_expertise_retrieve.sync(
    reviewer_profile_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: nested_reviewer_profile_expertise_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { nestedReviewerProfileExpertiseRetrieve } from 'waldur-js-client';

try {
  const response = await nestedReviewerProfileExpertiseRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "reviewer_profile_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
reviewer_profile_uuid string ✓ UUID of the parent reviewer profile
uuid string (uuid) ✓

200 -

Field Type Description
uuid string (uuid)
expertise_keyword string Free-text keyword
expertise_category string (uuid)
expertise_category_name string
proficiency_level string
Enum: expert, familiar, basic
years_experience integer
last_active_date string (date) When last worked in this area
created string (date-time)

Publications

1
2
3
4
http \
  GET \
  https://api.example.com/api/reviewer-profiles/a1b2c3d4-e5f6-7890-abcd-ef1234567890/publications/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.reviewer_profiles import nested_reviewer_profile_publications_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = nested_reviewer_profile_publications_list.sync(
    reviewer_profile_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

for item in response:
    print(item)
  1. API Source: nested_reviewer_profile_publications_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { nestedReviewerProfilePublicationsList } from 'waldur-js-client';

try {
  const response = await nestedReviewerProfilePublicationsList({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "reviewer_profile_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
reviewer_profile_uuid string ✓ UUID of the parent reviewer profile
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid)
title string
doi string Digital Object Identifier
publication_year integer
venue string Journal or conference name
venue_type string
Enum: journal, conference, preprint, book, thesis, report, other
abstract string
coauthors any List of co-author names and identifiers
external_ids any External identifiers:
is_excluded_from_matching boolean User can exclude old papers from expertise matching
created string (date-time)

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/reviewer-profiles/a1b2c3d4-e5f6-7890-abcd-ef1234567890/publications/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.reviewer_profiles import nested_reviewer_profile_publications_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = nested_reviewer_profile_publications_retrieve.sync(
    reviewer_profile_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: nested_reviewer_profile_publications_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { nestedReviewerProfilePublicationsRetrieve } from 'waldur-js-client';

try {
  const response = await nestedReviewerProfilePublicationsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "reviewer_profile_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
reviewer_profile_uuid string ✓ UUID of the parent reviewer profile
uuid string (uuid) ✓

200 -

Field Type Description
uuid string (uuid)
title string
doi string Digital Object Identifier
publication_year integer
venue string Journal or conference name
venue_type string
Enum: journal, conference, preprint, book, thesis, report, other
abstract string
coauthors any List of co-author names and identifiers
external_ids any External identifiers:
is_excluded_from_matching boolean User can exclude old papers from expertise matching
created string (date-time)

List affiliations for a reviewer profile

List affiliations for a reviewer profile.

1
2
3
4
http \
  GET \
  https://api.example.com/api/reviewer-profiles/a1b2c3d4-e5f6-7890-abcd-ef1234567890/affiliations/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.reviewer_profiles import reviewer_profiles_affiliations_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = reviewer_profiles_affiliations_list.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

for item in response:
    print(item)
  1. API Source: reviewer_profiles_affiliations_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { reviewerProfilesAffiliationsList } from 'waldur-js-client';

try {
  const response = await reviewerProfilesAffiliationsList({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid)
organization string (uuid)
organization_name string Organization name (used when not linked to Waldur org)
organization_name_display string Return organization name from linked Customer or from the text field.
organization_identifier string ROR, GRID, or other external identifier
department string
position_title string
start_date string (date)
end_date string (date) Leave empty for current affiliation
is_primary boolean
affiliation_type string
Enum: employment, education, visiting, honorary, consulting
created string (date-time)

Get ORCID OAuth authorization URL

Get ORCID OAuth authorization URL.

1
2
3
4
http \
  GET \
  https://api.example.com/api/reviewer-profiles/a1b2c3d4-e5f6-7890-abcd-ef1234567890/connect-orcid/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.reviewer_profiles import reviewer_profiles_connect_orcid_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = reviewer_profiles_connect_orcid_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: reviewer_profiles_connect_orcid_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { reviewerProfilesConnectOrcidRetrieve } from 'waldur-js-client';

try {
  const response = await reviewerProfilesConnectOrcidRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
authorization_url string

List expertise keywords for a reviewer profile

List expertise keywords for a reviewer profile.

1
2
3
4
http \
  GET \
  https://api.example.com/api/reviewer-profiles/a1b2c3d4-e5f6-7890-abcd-ef1234567890/expertise/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.reviewer_profiles import reviewer_profiles_expertise_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = reviewer_profiles_expertise_list.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

for item in response:
    print(item)
  1. API Source: reviewer_profiles_expertise_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { reviewerProfilesExpertiseList } from 'waldur-js-client';

try {
  const response = await reviewerProfilesExpertiseList({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid)
expertise_keyword string Free-text keyword
expertise_category string (uuid)
expertise_category_name string
proficiency_level string
Enum: expert, familiar, basic
years_experience integer
last_active_date string (date) When last worked in this area
created string (date-time)

List Reviewer Profiles

1
2
3
4
http \
  GET \
  https://api.example.com/api/reviewer-profiles/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.reviewer_profile_o_enum import ReviewerProfileOEnum # (1)
from waldur_api_client.api.reviewer_profiles import reviewer_profiles_list # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = reviewer_profiles_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: ReviewerProfileOEnum
  2. API Source: reviewer_profiles_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { reviewerProfilesList } from 'waldur-js-client';

try {
  const response = await reviewerProfilesList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
expertise_category_uuid string (uuid)
expertise_keyword string
has_orcid boolean
o array Ordering
orcid_id string
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
user_email string
user_name string
user_uuid string (uuid)

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
user string (uri)
user_uuid string (uuid)
user_full_name string
user_email string (email)
orcid_id string ORCID identifier (format: 0000-0000-0000-0000)
orcid_connected boolean Check if ORCID is connected (has access token).
orcid_last_sync string (date-time)
biography string Professional biography / summary
alternative_names any List of name variants used in publications
affiliations array of objects
affiliations.uuid string (uuid)
affiliations.organization string (uuid)
affiliations.organization_name string Organization name (used when not linked to Waldur org)
affiliations.organization_name_display string Return organization name from linked Customer or from the text field.
affiliations.organization_identifier string ROR, GRID, or other external identifier
affiliations.department string
affiliations.position_title string
affiliations.start_date string (date)
affiliations.end_date string (date) Leave empty for current affiliation
affiliations.is_primary boolean
affiliations.affiliation_type string
Enum: employment, education, visiting, honorary, consulting
affiliations.created string (date-time)
expertise_set array of objects
expertise_set.uuid string (uuid)
expertise_set.expertise_keyword string Free-text keyword
expertise_set.expertise_category string (uuid)
expertise_set.expertise_category_name string
expertise_set.proficiency_level string
Enum: expert, familiar, basic
expertise_set.years_experience integer
expertise_set.last_active_date string (date) When last worked in this area
expertise_set.created string (date-time)
publications array of objects
publications.uuid string (uuid)
publications.title string
publications.doi string Digital Object Identifier
publications.publication_year integer
publications.venue string Journal or conference name
publications.venue_type string
Enum: journal, conference, preprint, book, thesis, report, other
publications.abstract string
publications.coauthors any List of co-author names and identifiers
publications.external_ids any External identifiers:
publications.is_excluded_from_matching boolean User can exclude old papers from expertise matching
publications.created string (date-time)
stats any
profile_completeness object (free-form) Calculate profile completeness percentage and missing fields.
is_published boolean Whether profile is discoverable by call managers
published_at string (date-time) When the profile was published
available_for_reviews boolean Whether reviewer is currently accepting review requests
created string (date-time)
modified string (date-time)

Get or create reviewer profile for the current user

Get or create reviewer profile for the current user.

1
2
3
4
http \
  GET \
  https://api.example.com/api/reviewer-profiles/me/ \
  Authorization:"Token YOUR_API_TOKEN"

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.reviewer_profiles import reviewer_profiles_me_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = reviewer_profiles_me_retrieve.sync(client=client)

print(response)
  1. API Source: reviewer_profiles_me_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { reviewerProfilesMeRetrieve } from 'waldur-js-client';

try {
  const response = await reviewerProfilesMeRetrieve({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

200 -

Field Type Description
url string (uri)
uuid string (uuid)
user string (uri)
user_uuid string (uuid)
user_full_name string
user_email string (email)
orcid_id string ORCID identifier (format: 0000-0000-0000-0000)
orcid_connected boolean Check if ORCID is connected (has access token).
orcid_last_sync string (date-time)
biography string Professional biography / summary
alternative_names any List of name variants used in publications
affiliations array of objects
affiliations.uuid string (uuid)
affiliations.organization string (uuid)
affiliations.organization_name string Organization name (used when not linked to Waldur org)
affiliations.organization_name_display string Return organization name from linked Customer or from the text field.
affiliations.organization_identifier string ROR, GRID, or other external identifier
affiliations.department string
affiliations.position_title string
affiliations.start_date string (date)
affiliations.end_date string (date) Leave empty for current affiliation
affiliations.is_primary boolean
affiliations.affiliation_type string
Enum: employment, education, visiting, honorary, consulting
affiliations.created string (date-time)
expertise_set array of objects
expertise_set.uuid string (uuid)
expertise_set.expertise_keyword string Free-text keyword
expertise_set.expertise_category string (uuid)
expertise_set.expertise_category_name string
expertise_set.proficiency_level string
Enum: expert, familiar, basic
expertise_set.years_experience integer
expertise_set.last_active_date string (date) When last worked in this area
expertise_set.created string (date-time)
publications array of objects
publications.uuid string (uuid)
publications.title string
publications.doi string Digital Object Identifier
publications.publication_year integer
publications.venue string Journal or conference name
publications.venue_type string
Enum: journal, conference, preprint, book, thesis, report, other
publications.abstract string
publications.coauthors any List of co-author names and identifiers
publications.external_ids any External identifiers:
publications.is_excluded_from_matching boolean User can exclude old papers from expertise matching
publications.created string (date-time)
stats any
profile_completeness object (free-form) Calculate profile completeness percentage and missing fields.
is_published boolean Whether profile is discoverable by call managers
published_at string (date-time) When the profile was published
available_for_reviews boolean Whether reviewer is currently accepting review requests
created string (date-time)
modified string (date-time)

List publications for a reviewer profile

List publications for a reviewer profile.

1
2
3
4
http \
  GET \
  https://api.example.com/api/reviewer-profiles/a1b2c3d4-e5f6-7890-abcd-ef1234567890/publications/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.reviewer_profiles import reviewer_profiles_publications_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = reviewer_profiles_publications_list.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

for item in response:
    print(item)
  1. API Source: reviewer_profiles_publications_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { reviewerProfilesPublicationsList } from 'waldur-js-client';

try {
  const response = await reviewerProfilesPublicationsList({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid)
title string
doi string Digital Object Identifier
publication_year integer
venue string Journal or conference name
venue_type string
Enum: journal, conference, preprint, book, thesis, report, other
abstract string
coauthors any List of co-author names and identifiers
external_ids any External identifiers:
is_excluded_from_matching boolean User can exclude old papers from expertise matching
created string (date-time)

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/reviewer-profiles/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.reviewer_profiles import reviewer_profiles_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = reviewer_profiles_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: reviewer_profiles_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { reviewerProfilesRetrieve } from 'waldur-js-client';

try {
  const response = await reviewerProfilesRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
url string (uri)
uuid string (uuid)
user string (uri)
user_uuid string (uuid)
user_full_name string
user_email string (email)
orcid_id string ORCID identifier (format: 0000-0000-0000-0000)
orcid_connected boolean Check if ORCID is connected (has access token).
orcid_last_sync string (date-time)
biography string Professional biography / summary
alternative_names any List of name variants used in publications
affiliations array of objects
affiliations.uuid string (uuid)
affiliations.organization string (uuid)
affiliations.organization_name string Organization name (used when not linked to Waldur org)
affiliations.organization_name_display string Return organization name from linked Customer or from the text field.
affiliations.organization_identifier string ROR, GRID, or other external identifier
affiliations.department string
affiliations.position_title string
affiliations.start_date string (date)
affiliations.end_date string (date) Leave empty for current affiliation
affiliations.is_primary boolean
affiliations.affiliation_type string
Enum: employment, education, visiting, honorary, consulting
affiliations.created string (date-time)
expertise_set array of objects
expertise_set.uuid string (uuid)
expertise_set.expertise_keyword string Free-text keyword
expertise_set.expertise_category string (uuid)
expertise_set.expertise_category_name string
expertise_set.proficiency_level string
Enum: expert, familiar, basic
expertise_set.years_experience integer
expertise_set.last_active_date string (date) When last worked in this area
expertise_set.created string (date-time)
publications array of objects
publications.uuid string (uuid)
publications.title string
publications.doi string Digital Object Identifier
publications.publication_year integer
publications.venue string Journal or conference name
publications.venue_type string
Enum: journal, conference, preprint, book, thesis, report, other
publications.abstract string
publications.coauthors any List of co-author names and identifiers
publications.external_ids any External identifiers:
publications.is_excluded_from_matching boolean User can exclude old papers from expertise matching
publications.created string (date-time)
stats any
profile_completeness object (free-form) Calculate profile completeness percentage and missing fields.
is_published boolean Whether profile is discoverable by call managers
published_at string (date-time) When the profile was published
available_for_reviews boolean Whether reviewer is currently accepting review requests
created string (date-time)
modified string (date-time)

Affiliations

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/reviewer-profiles/a1b2c3d4-e5f6-7890-abcd-ef1234567890/affiliations/ \
  Authorization:"Token YOUR_API_TOKEN" \
  organization_name="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.reviewer_affiliation_request import ReviewerAffiliationRequest # (1)
from waldur_api_client.api.reviewer_profiles import nested_reviewer_profile_affiliations_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ReviewerAffiliationRequest(
    organization_name="string-value"
)
response = nested_reviewer_profile_affiliations_create.sync(
    reviewer_profile_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ReviewerAffiliationRequest
  2. API Source: nested_reviewer_profile_affiliations_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { nestedReviewerProfileAffiliationsCreate } from 'waldur-js-client';

try {
  const response = await nestedReviewerProfileAffiliationsCreate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "reviewer_profile_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "organization_name": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
reviewer_profile_uuid string ✓ UUID of the parent reviewer profile
Field Type Required Description
organization string (uuid)
organization_name string ✓ Organization name (used when not linked to Waldur org)
organization_identifier string ROR, GRID, or other external identifier
department string
position_title string
start_date string (date)
end_date string (date) Leave empty for current affiliation
is_primary boolean
affiliation_type string
Enum: employment, education, visiting, honorary, consulting

201 -

Field Type Description
uuid string (uuid)
organization string (uuid)
organization_name string Organization name (used when not linked to Waldur org)
organization_name_display string Return organization name from linked Customer or from the text field.
organization_identifier string ROR, GRID, or other external identifier
department string
position_title string
start_date string (date)
end_date string (date) Leave empty for current affiliation
is_primary boolean
affiliation_type string
Enum: employment, education, visiting, honorary, consulting
created string (date-time)

Expertise

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/reviewer-profiles/a1b2c3d4-e5f6-7890-abcd-ef1234567890/expertise/ \
  Authorization:"Token YOUR_API_TOKEN" \
  expertise_keyword="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.reviewer_expertise_request import ReviewerExpertiseRequest # (1)
from waldur_api_client.api.reviewer_profiles import nested_reviewer_profile_expertise_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ReviewerExpertiseRequest(
    expertise_keyword="string-value"
)
response = nested_reviewer_profile_expertise_create.sync(
    reviewer_profile_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ReviewerExpertiseRequest
  2. API Source: nested_reviewer_profile_expertise_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { nestedReviewerProfileExpertiseCreate } from 'waldur-js-client';

try {
  const response = await nestedReviewerProfileExpertiseCreate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "reviewer_profile_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "expertise_keyword": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
reviewer_profile_uuid string ✓ UUID of the parent reviewer profile
Field Type Required Description
expertise_keyword string ✓ Free-text keyword
expertise_category string (uuid)
proficiency_level string
Enum: expert, familiar, basic
years_experience integer
last_active_date string (date) When last worked in this area

201 -

Field Type Description
uuid string (uuid)
expertise_keyword string Free-text keyword
expertise_category string (uuid)
expertise_category_name string
proficiency_level string
Enum: expert, familiar, basic
years_experience integer
last_active_date string (date) When last worked in this area
created string (date-time)

Publications

1
2
3
4
5
6
7
http \
  POST \
  https://api.example.com/api/reviewer-profiles/a1b2c3d4-e5f6-7890-abcd-ef1234567890/publications/ \
  Authorization:"Token YOUR_API_TOKEN" \
  title="string-value" \
  publication_year=123 \
  venue="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.reviewer_publication_request import ReviewerPublicationRequest # (1)
from waldur_api_client.api.reviewer_profiles import nested_reviewer_profile_publications_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ReviewerPublicationRequest(
    title="string-value",
    publication_year=123,
    venue="string-value"
)
response = nested_reviewer_profile_publications_create.sync(
    reviewer_profile_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ReviewerPublicationRequest
  2. API Source: nested_reviewer_profile_publications_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
import { nestedReviewerProfilePublicationsCreate } from 'waldur-js-client';

try {
  const response = await nestedReviewerProfilePublicationsCreate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "reviewer_profile_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "title": "string-value",
    "publication_year": 123,
    "venue": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
reviewer_profile_uuid string ✓ UUID of the parent reviewer profile
Field Type Required Description
title string ✓
doi string Digital Object Identifier
publication_year integer ✓
venue string ✓ Journal or conference name
venue_type string
Enum: journal, conference, preprint, book, thesis, report, other
abstract string
coauthors any List of co-author names and identifiers
external_ids any External identifiers:
is_excluded_from_matching boolean User can exclude old papers from expertise matching

201 -

Field Type Description
uuid string (uuid)
title string
doi string Digital Object Identifier
publication_year integer
venue string Journal or conference name
venue_type string
Enum: journal, conference, preprint, book, thesis, report, other
abstract string
coauthors any List of co-author names and identifiers
external_ids any External identifiers:
is_excluded_from_matching boolean User can exclude old papers from expertise matching
created string (date-time)

Create affiliation for a reviewer profile

Create affiliation for a reviewer profile.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/reviewer-profiles/a1b2c3d4-e5f6-7890-abcd-ef1234567890/affiliations/ \
  Authorization:"Token YOUR_API_TOKEN" \
  organization_name="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.reviewer_affiliation_request import ReviewerAffiliationRequest # (1)
from waldur_api_client.api.reviewer_profiles import reviewer_profiles_affiliations_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ReviewerAffiliationRequest(
    organization_name="string-value"
)
response = reviewer_profiles_affiliations_create.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ReviewerAffiliationRequest
  2. API Source: reviewer_profiles_affiliations_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { reviewerProfilesAffiliationsCreate } from 'waldur-js-client';

try {
  const response = await reviewerProfilesAffiliationsCreate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "organization_name": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
organization string (uuid)
organization_name string ✓ Organization name (used when not linked to Waldur org)
organization_identifier string ROR, GRID, or other external identifier
department string
position_title string
start_date string (date)
end_date string (date) Leave empty for current affiliation
is_primary boolean
affiliation_type string
Enum: employment, education, visiting, honorary, consulting

200 -

Field Type Description
uuid string (uuid)
organization string (uuid)
organization_name string Organization name (used when not linked to Waldur org)
organization_name_display string Return organization name from linked Customer or from the text field.
organization_identifier string ROR, GRID, or other external identifier
department string
position_title string
start_date string (date)
end_date string (date) Leave empty for current affiliation
is_primary boolean
affiliation_type string
Enum: employment, education, visiting, honorary, consulting
created string (date-time)

Complete ORCID OAuth connection with authorization code

Complete ORCID OAuth connection with authorization code.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/reviewer-profiles/a1b2c3d4-e5f6-7890-abcd-ef1234567890/connect-orcid/callback/ \
  Authorization:"Token YOUR_API_TOKEN" \
  code="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.orcid_callback_request import OrcidCallbackRequest # (1)
from waldur_api_client.api.reviewer_profiles import reviewer_profiles_connect_orcid_callback # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OrcidCallbackRequest(
    code="string-value"
)
response = reviewer_profiles_connect_orcid_callback.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OrcidCallbackRequest
  2. API Source: reviewer_profiles_connect_orcid_callback
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { reviewerProfilesConnectOrcidCallback } from 'waldur-js-client';

try {
  const response = await reviewerProfilesConnectOrcidCallback({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "code": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
code string ✓ Authorization code from ORCID OAuth callback
state string State token for CSRF protection

200 -

Field Type Description
url string (uri)
uuid string (uuid)
user string (uri)
user_uuid string (uuid)
user_full_name string
user_email string (email)
orcid_id string ORCID identifier (format: 0000-0000-0000-0000)
orcid_connected boolean Check if ORCID is connected (has access token).
orcid_last_sync string (date-time)
biography string Professional biography / summary
alternative_names any List of name variants used in publications
affiliations array of objects
affiliations.uuid string (uuid)
affiliations.organization string (uuid)
affiliations.organization_name string Organization name (used when not linked to Waldur org)
affiliations.organization_name_display string Return organization name from linked Customer or from the text field.
affiliations.organization_identifier string ROR, GRID, or other external identifier
affiliations.department string
affiliations.position_title string
affiliations.start_date string (date)
affiliations.end_date string (date) Leave empty for current affiliation
affiliations.is_primary boolean
affiliations.affiliation_type string
Enum: employment, education, visiting, honorary, consulting
affiliations.created string (date-time)
expertise_set array of objects
expertise_set.uuid string (uuid)
expertise_set.expertise_keyword string Free-text keyword
expertise_set.expertise_category string (uuid)
expertise_set.expertise_category_name string
expertise_set.proficiency_level string
Enum: expert, familiar, basic
expertise_set.years_experience integer
expertise_set.last_active_date string (date) When last worked in this area
expertise_set.created string (date-time)
publications array of objects
publications.uuid string (uuid)
publications.title string
publications.doi string Digital Object Identifier
publications.publication_year integer
publications.venue string Journal or conference name
publications.venue_type string
Enum: journal, conference, preprint, book, thesis, report, other
publications.abstract string
publications.coauthors any List of co-author names and identifiers
publications.external_ids any External identifiers:
publications.is_excluded_from_matching boolean User can exclude old papers from expertise matching
publications.created string (date-time)
stats any
profile_completeness object (free-form) Calculate profile completeness percentage and missing fields.
is_published boolean Whether profile is discoverable by call managers
published_at string (date-time) When the profile was published
available_for_reviews boolean Whether reviewer is currently accepting review requests
created string (date-time)
modified string (date-time)

Create

1
2
3
4
http \
  POST \
  https://api.example.com/api/reviewer-profiles/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.reviewer_profile_request import ReviewerProfileRequest # (1)
from waldur_api_client.api.reviewer_profiles import reviewer_profiles_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ReviewerProfileRequest()
response = reviewer_profiles_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ReviewerProfileRequest
  2. API Source: reviewer_profiles_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { reviewerProfilesCreate } from 'waldur-js-client';

try {
  const response = await reviewerProfilesCreate({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
orcid_id string ORCID identifier (format: 0000-0000-0000-0000)
biography string Professional biography / summary
alternative_names any List of name variants used in publications
available_for_reviews boolean Whether reviewer is currently accepting review requests

201 -

Field Type Description
url string (uri)
uuid string (uuid)
user string (uri)
user_uuid string (uuid)
user_full_name string
user_email string (email)
orcid_id string ORCID identifier (format: 0000-0000-0000-0000)
orcid_connected boolean Check if ORCID is connected (has access token).
orcid_last_sync string (date-time)
biography string Professional biography / summary
alternative_names any List of name variants used in publications
affiliations array of objects
affiliations.uuid string (uuid)
affiliations.organization string (uuid)
affiliations.organization_name string Organization name (used when not linked to Waldur org)
affiliations.organization_name_display string Return organization name from linked Customer or from the text field.
affiliations.organization_identifier string ROR, GRID, or other external identifier
affiliations.department string
affiliations.position_title string
affiliations.start_date string (date)
affiliations.end_date string (date) Leave empty for current affiliation
affiliations.is_primary boolean
affiliations.affiliation_type string
Enum: employment, education, visiting, honorary, consulting
affiliations.created string (date-time)
expertise_set array of objects
expertise_set.uuid string (uuid)
expertise_set.expertise_keyword string Free-text keyword
expertise_set.expertise_category string (uuid)
expertise_set.expertise_category_name string
expertise_set.proficiency_level string
Enum: expert, familiar, basic
expertise_set.years_experience integer
expertise_set.last_active_date string (date) When last worked in this area
expertise_set.created string (date-time)
publications array of objects
publications.uuid string (uuid)
publications.title string
publications.doi string Digital Object Identifier
publications.publication_year integer
publications.venue string Journal or conference name
publications.venue_type string
Enum: journal, conference, preprint, book, thesis, report, other
publications.abstract string
publications.coauthors any List of co-author names and identifiers
publications.external_ids any External identifiers:
publications.is_excluded_from_matching boolean User can exclude old papers from expertise matching
publications.created string (date-time)
stats any
profile_completeness object (free-form) Calculate profile completeness percentage and missing fields.
is_published boolean Whether profile is discoverable by call managers
published_at string (date-time) When the profile was published
available_for_reviews boolean Whether reviewer is currently accepting review requests
created string (date-time)
modified string (date-time)

Disconnect ORCID from profile

Disconnect ORCID from profile.

1
2
3
4
http \
  POST \
  https://api.example.com/api/reviewer-profiles/a1b2c3d4-e5f6-7890-abcd-ef1234567890/disconnect-orcid/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.reviewer_profile_request import ReviewerProfileRequest # (1)
from waldur_api_client.api.reviewer_profiles import reviewer_profiles_disconnect_orcid # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ReviewerProfileRequest()
response = reviewer_profiles_disconnect_orcid.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ReviewerProfileRequest
  2. API Source: reviewer_profiles_disconnect_orcid
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { reviewerProfilesDisconnectOrcid } from 'waldur-js-client';

try {
  const response = await reviewerProfilesDisconnectOrcid({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
orcid_id string ORCID identifier (format: 0000-0000-0000-0000)
biography string Professional biography / summary
alternative_names any List of name variants used in publications
available_for_reviews boolean Whether reviewer is currently accepting review requests

200 -

Field Type
detail string

Create expertise entry for a reviewer profile

Create expertise entry for a reviewer profile.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/reviewer-profiles/a1b2c3d4-e5f6-7890-abcd-ef1234567890/expertise/ \
  Authorization:"Token YOUR_API_TOKEN" \
  expertise_keyword="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.reviewer_expertise_request import ReviewerExpertiseRequest # (1)
from waldur_api_client.api.reviewer_profiles import reviewer_profiles_expertise_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ReviewerExpertiseRequest(
    expertise_keyword="string-value"
)
response = reviewer_profiles_expertise_create.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ReviewerExpertiseRequest
  2. API Source: reviewer_profiles_expertise_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { reviewerProfilesExpertiseCreate } from 'waldur-js-client';

try {
  const response = await reviewerProfilesExpertiseCreate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "expertise_keyword": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
expertise_keyword string ✓ Free-text keyword
expertise_category string (uuid)
proficiency_level string
Enum: expert, familiar, basic
years_experience integer
last_active_date string (date) When last worked in this area

200 -

Field Type Description
uuid string (uuid)
expertise_keyword string Free-text keyword
expertise_category string (uuid)
expertise_category_name string
proficiency_level string
Enum: expert, familiar, basic
years_experience integer
last_active_date string (date) When last worked in this area
created string (date-time)

Import publications from ORCID or other sources

Import publications from ORCID or other sources.

1
2
3
4
http \
  POST \
  https://api.example.com/api/reviewer-profiles/a1b2c3d4-e5f6-7890-abcd-ef1234567890/import-publications/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.import_publications_request import ImportPublicationsRequest # (1)
from waldur_api_client.api.reviewer_profiles import reviewer_profiles_import_publications # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ImportPublicationsRequest()
response = reviewer_profiles_import_publications.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ImportPublicationsRequest
  2. API Source: reviewer_profiles_import_publications
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { reviewerProfilesImportPublications } from 'waldur-js-client';

try {
  const response = await reviewerProfilesImportPublications({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
source any Source to import publications from
Constraints: default: orcid
doi string DOI of publication to import (required if source is 'doi')

200 -

Field Type
imported_count integer

Get or create reviewer profile for the current user

Get or create reviewer profile for the current user.

1
2
3
4
http \
  POST \
  https://api.example.com/api/reviewer-profiles/me/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.reviewer_profile_create_request import ReviewerProfileCreateRequest # (1)
from waldur_api_client.api.reviewer_profiles import reviewer_profiles_me # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ReviewerProfileCreateRequest()
response = reviewer_profiles_me.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ReviewerProfileCreateRequest
  2. API Source: reviewer_profiles_me
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { reviewerProfilesMe } from 'waldur-js-client';

try {
  const response = await reviewerProfilesMe({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
orcid_id string ORCID identifier (format: 0000-0000-0000-0000)
biography string Professional biography / summary
alternative_names any List of name variants used in publications
available_for_reviews boolean Whether reviewer is currently accepting review requests

200 -

Field Type Description
url string (uri)
uuid string (uuid)
user string (uri)
user_uuid string (uuid)
user_full_name string
user_email string (email)
orcid_id string ORCID identifier (format: 0000-0000-0000-0000)
orcid_connected boolean Check if ORCID is connected (has access token).
orcid_last_sync string (date-time)
biography string Professional biography / summary
alternative_names any List of name variants used in publications
affiliations array of objects
affiliations.uuid string (uuid)
affiliations.organization string (uuid)
affiliations.organization_name string Organization name (used when not linked to Waldur org)
affiliations.organization_name_display string Return organization name from linked Customer or from the text field.
affiliations.organization_identifier string ROR, GRID, or other external identifier
affiliations.department string
affiliations.position_title string
affiliations.start_date string (date)
affiliations.end_date string (date) Leave empty for current affiliation
affiliations.is_primary boolean
affiliations.affiliation_type string
Enum: employment, education, visiting, honorary, consulting
affiliations.created string (date-time)
expertise_set array of objects
expertise_set.uuid string (uuid)
expertise_set.expertise_keyword string Free-text keyword
expertise_set.expertise_category string (uuid)
expertise_set.expertise_category_name string
expertise_set.proficiency_level string
Enum: expert, familiar, basic
expertise_set.years_experience integer
expertise_set.last_active_date string (date) When last worked in this area
expertise_set.created string (date-time)
publications array of objects
publications.uuid string (uuid)
publications.title string
publications.doi string Digital Object Identifier
publications.publication_year integer
publications.venue string Journal or conference name
publications.venue_type string
Enum: journal, conference, preprint, book, thesis, report, other
publications.abstract string
publications.coauthors any List of co-author names and identifiers
publications.external_ids any External identifiers:
publications.is_excluded_from_matching boolean User can exclude old papers from expertise matching
publications.created string (date-time)
stats any
profile_completeness object (free-form) Calculate profile completeness percentage and missing fields.
is_published boolean Whether profile is discoverable by call managers
published_at string (date-time) When the profile was published
available_for_reviews boolean Whether reviewer is currently accepting review requests
created string (date-time)
modified string (date-time)

Create publication for a reviewer profile

Create publication for a reviewer profile.

1
2
3
4
5
6
7
http \
  POST \
  https://api.example.com/api/reviewer-profiles/a1b2c3d4-e5f6-7890-abcd-ef1234567890/publications/ \
  Authorization:"Token YOUR_API_TOKEN" \
  title="string-value" \
  publication_year=123 \
  venue="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.reviewer_publication_request import ReviewerPublicationRequest # (1)
from waldur_api_client.api.reviewer_profiles import reviewer_profiles_publications_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ReviewerPublicationRequest(
    title="string-value",
    publication_year=123,
    venue="string-value"
)
response = reviewer_profiles_publications_create.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ReviewerPublicationRequest
  2. API Source: reviewer_profiles_publications_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
import { reviewerProfilesPublicationsCreate } from 'waldur-js-client';

try {
  const response = await reviewerProfilesPublicationsCreate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "title": "string-value",
    "publication_year": 123,
    "venue": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
title string ✓
doi string Digital Object Identifier
publication_year integer ✓
venue string ✓ Journal or conference name
venue_type string
Enum: journal, conference, preprint, book, thesis, report, other
abstract string
coauthors any List of co-author names and identifiers
external_ids any External identifiers:
is_excluded_from_matching boolean User can exclude old papers from expertise matching

200 -

Field Type Description
uuid string (uuid)
title string
doi string Digital Object Identifier
publication_year integer
venue string Journal or conference name
venue_type string
Enum: journal, conference, preprint, book, thesis, report, other
abstract string
coauthors any List of co-author names and identifiers
external_ids any External identifiers:
is_excluded_from_matching boolean User can exclude old papers from expertise matching
created string (date-time)

Publish

Publish reviewer profile for discovery by call managers. Warning: Publishing makes your full profile visible to call managers globally.

1
2
3
4
http \
  POST \
  https://api.example.com/api/reviewer-profiles/publish/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.reviewer_profile_request import ReviewerProfileRequest # (1)
from waldur_api_client.api.reviewer_profiles import reviewer_profiles_publish # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ReviewerProfileRequest()
response = reviewer_profiles_publish.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ReviewerProfileRequest
  2. API Source: reviewer_profiles_publish
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { reviewerProfilesPublish } from 'waldur-js-client';

try {
  const response = await reviewerProfilesPublish({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
orcid_id string ORCID identifier (format: 0000-0000-0000-0000)
biography string Professional biography / summary
alternative_names any List of name variants used in publications
available_for_reviews boolean Whether reviewer is currently accepting review requests

200 -

Field Type
is_published boolean
published_at string (date-time)
warning string

Sync profile data from ORCID

Sync profile data from ORCID.

1
2
3
4
http \
  POST \
  https://api.example.com/api/reviewer-profiles/a1b2c3d4-e5f6-7890-abcd-ef1234567890/sync-orcid/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.reviewer_profile_request import ReviewerProfileRequest # (1)
from waldur_api_client.api.reviewer_profiles import reviewer_profiles_sync_orcid # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ReviewerProfileRequest()
response = reviewer_profiles_sync_orcid.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ReviewerProfileRequest
  2. API Source: reviewer_profiles_sync_orcid
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { reviewerProfilesSyncOrcid } from 'waldur-js-client';

try {
  const response = await reviewerProfilesSyncOrcid({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
orcid_id string ORCID identifier (format: 0000-0000-0000-0000)
biography string Professional biography / summary
alternative_names any List of name variants used in publications
available_for_reviews boolean Whether reviewer is currently accepting review requests

200 -

Field Type
imported object (free-form)
last_sync string (date-time)

Unpublish reviewer profile to remove it from discovery

Unpublish reviewer profile to remove it from discovery.

1
2
3
4
http \
  POST \
  https://api.example.com/api/reviewer-profiles/unpublish/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.reviewer_profile_request import ReviewerProfileRequest # (1)
from waldur_api_client.api.reviewer_profiles import reviewer_profiles_unpublish # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ReviewerProfileRequest()
response = reviewer_profiles_unpublish.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ReviewerProfileRequest
  2. API Source: reviewer_profiles_unpublish
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { reviewerProfilesUnpublish } from 'waldur-js-client';

try {
  const response = await reviewerProfilesUnpublish({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
orcid_id string ORCID identifier (format: 0000-0000-0000-0000)
biography string Professional biography / summary
alternative_names any List of name variants used in publications
available_for_reviews boolean Whether reviewer is currently accepting review requests

200 -

Field Type
is_published boolean
detail string

Update

1
2
3
4
5
http \
  PUT \
  https://api.example.com/api/reviewer-profiles/a1b2c3d4-e5f6-7890-abcd-ef1234567890/affiliations/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  organization_name="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.reviewer_affiliation_request import ReviewerAffiliationRequest # (1)
from waldur_api_client.api.reviewer_profiles import nested_reviewer_profile_affiliations_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ReviewerAffiliationRequest(
    organization_name="string-value"
)
response = nested_reviewer_profile_affiliations_update.sync(
    reviewer_profile_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ReviewerAffiliationRequest
  2. API Source: nested_reviewer_profile_affiliations_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { nestedReviewerProfileAffiliationsUpdate } from 'waldur-js-client';

try {
  const response = await nestedReviewerProfileAffiliationsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "reviewer_profile_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "organization_name": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
reviewer_profile_uuid string ✓ UUID of the parent reviewer profile
uuid string (uuid) ✓
Field Type Required Description
organization string (uuid)
organization_name string ✓ Organization name (used when not linked to Waldur org)
organization_identifier string ROR, GRID, or other external identifier
department string
position_title string
start_date string (date)
end_date string (date) Leave empty for current affiliation
is_primary boolean
affiliation_type string
Enum: employment, education, visiting, honorary, consulting

200 -

Field Type Description
uuid string (uuid)
organization string (uuid)
organization_name string Organization name (used when not linked to Waldur org)
organization_name_display string Return organization name from linked Customer or from the text field.
organization_identifier string ROR, GRID, or other external identifier
department string
position_title string
start_date string (date)
end_date string (date) Leave empty for current affiliation
is_primary boolean
affiliation_type string
Enum: employment, education, visiting, honorary, consulting
created string (date-time)

Update

1
2
3
4
5
http \
  PUT \
  https://api.example.com/api/reviewer-profiles/a1b2c3d4-e5f6-7890-abcd-ef1234567890/expertise/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  expertise_keyword="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.reviewer_expertise_request import ReviewerExpertiseRequest # (1)
from waldur_api_client.api.reviewer_profiles import nested_reviewer_profile_expertise_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ReviewerExpertiseRequest(
    expertise_keyword="string-value"
)
response = nested_reviewer_profile_expertise_update.sync(
    reviewer_profile_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ReviewerExpertiseRequest
  2. API Source: nested_reviewer_profile_expertise_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { nestedReviewerProfileExpertiseUpdate } from 'waldur-js-client';

try {
  const response = await nestedReviewerProfileExpertiseUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "reviewer_profile_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "expertise_keyword": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
reviewer_profile_uuid string ✓ UUID of the parent reviewer profile
uuid string (uuid) ✓
Field Type Required Description
expertise_keyword string ✓ Free-text keyword
expertise_category string (uuid)
proficiency_level string
Enum: expert, familiar, basic
years_experience integer
last_active_date string (date) When last worked in this area

200 -

Field Type Description
uuid string (uuid)
expertise_keyword string Free-text keyword
expertise_category string (uuid)
expertise_category_name string
proficiency_level string
Enum: expert, familiar, basic
years_experience integer
last_active_date string (date) When last worked in this area
created string (date-time)

Update

1
2
3
4
5
6
7
http \
  PUT \
  https://api.example.com/api/reviewer-profiles/a1b2c3d4-e5f6-7890-abcd-ef1234567890/publications/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  title="string-value" \
  publication_year=123 \
  venue="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.reviewer_publication_request import ReviewerPublicationRequest # (1)
from waldur_api_client.api.reviewer_profiles import nested_reviewer_profile_publications_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ReviewerPublicationRequest(
    title="string-value",
    publication_year=123,
    venue="string-value"
)
response = nested_reviewer_profile_publications_update.sync(
    reviewer_profile_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ReviewerPublicationRequest
  2. API Source: nested_reviewer_profile_publications_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
import { nestedReviewerProfilePublicationsUpdate } from 'waldur-js-client';

try {
  const response = await nestedReviewerProfilePublicationsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "reviewer_profile_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "title": "string-value",
    "publication_year": 123,
    "venue": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
reviewer_profile_uuid string ✓ UUID of the parent reviewer profile
uuid string (uuid) ✓
Field Type Required Description
title string ✓
doi string Digital Object Identifier
publication_year integer ✓
venue string ✓ Journal or conference name
venue_type string
Enum: journal, conference, preprint, book, thesis, report, other
abstract string
coauthors any List of co-author names and identifiers
external_ids any External identifiers:
is_excluded_from_matching boolean User can exclude old papers from expertise matching

200 -

Field Type Description
uuid string (uuid)
title string
doi string Digital Object Identifier
publication_year integer
venue string Journal or conference name
venue_type string
Enum: journal, conference, preprint, book, thesis, report, other
abstract string
coauthors any List of co-author names and identifiers
external_ids any External identifiers:
is_excluded_from_matching boolean User can exclude old papers from expertise matching
created string (date-time)

Update

1
2
3
4
http \
  PUT \
  https://api.example.com/api/reviewer-profiles/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.reviewer_profile_request import ReviewerProfileRequest # (1)
from waldur_api_client.api.reviewer_profiles import reviewer_profiles_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ReviewerProfileRequest()
response = reviewer_profiles_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ReviewerProfileRequest
  2. API Source: reviewer_profiles_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { reviewerProfilesUpdate } from 'waldur-js-client';

try {
  const response = await reviewerProfilesUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
orcid_id string ORCID identifier (format: 0000-0000-0000-0000)
biography string Professional biography / summary
alternative_names any List of name variants used in publications
available_for_reviews boolean Whether reviewer is currently accepting review requests

200 -

Field Type Description
url string (uri)
uuid string (uuid)
user string (uri)
user_uuid string (uuid)
user_full_name string
user_email string (email)
orcid_id string ORCID identifier (format: 0000-0000-0000-0000)
orcid_connected boolean Check if ORCID is connected (has access token).
orcid_last_sync string (date-time)
biography string Professional biography / summary
alternative_names any List of name variants used in publications
affiliations array of objects
affiliations.uuid string (uuid)
affiliations.organization string (uuid)
affiliations.organization_name string Organization name (used when not linked to Waldur org)
affiliations.organization_name_display string Return organization name from linked Customer or from the text field.
affiliations.organization_identifier string ROR, GRID, or other external identifier
affiliations.department string
affiliations.position_title string
affiliations.start_date string (date)
affiliations.end_date string (date) Leave empty for current affiliation
affiliations.is_primary boolean
affiliations.affiliation_type string
Enum: employment, education, visiting, honorary, consulting
affiliations.created string (date-time)
expertise_set array of objects
expertise_set.uuid string (uuid)
expertise_set.expertise_keyword string Free-text keyword
expertise_set.expertise_category string (uuid)
expertise_set.expertise_category_name string
expertise_set.proficiency_level string
Enum: expert, familiar, basic
expertise_set.years_experience integer
expertise_set.last_active_date string (date) When last worked in this area
expertise_set.created string (date-time)
publications array of objects
publications.uuid string (uuid)
publications.title string
publications.doi string Digital Object Identifier
publications.publication_year integer
publications.venue string Journal or conference name
publications.venue_type string
Enum: journal, conference, preprint, book, thesis, report, other
publications.abstract string
publications.coauthors any List of co-author names and identifiers
publications.external_ids any External identifiers:
publications.is_excluded_from_matching boolean User can exclude old papers from expertise matching
publications.created string (date-time)
stats any
profile_completeness object (free-form) Calculate profile completeness percentage and missing fields.
is_published boolean Whether profile is discoverable by call managers
published_at string (date-time) When the profile was published
available_for_reviews boolean Whether reviewer is currently accepting review requests
created string (date-time)
modified string (date-time)

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/reviewer-profiles/a1b2c3d4-e5f6-7890-abcd-ef1234567890/affiliations/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_reviewer_affiliation_request import PatchedReviewerAffiliationRequest # (1)
from waldur_api_client.api.reviewer_profiles import nested_reviewer_profile_affiliations_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedReviewerAffiliationRequest()
response = nested_reviewer_profile_affiliations_partial_update.sync(
    reviewer_profile_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedReviewerAffiliationRequest
  2. API Source: nested_reviewer_profile_affiliations_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { nestedReviewerProfileAffiliationsPartialUpdate } from 'waldur-js-client';

try {
  const response = await nestedReviewerProfileAffiliationsPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "reviewer_profile_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
reviewer_profile_uuid string ✓ UUID of the parent reviewer profile
uuid string (uuid) ✓
Field Type Required Description
organization string (uuid)
organization_name string Organization name (used when not linked to Waldur org)
organization_identifier string ROR, GRID, or other external identifier
department string
position_title string
start_date string (date)
end_date string (date) Leave empty for current affiliation
is_primary boolean
affiliation_type string
Enum: employment, education, visiting, honorary, consulting

200 -

Field Type Description
uuid string (uuid)
organization string (uuid)
organization_name string Organization name (used when not linked to Waldur org)
organization_name_display string Return organization name from linked Customer or from the text field.
organization_identifier string ROR, GRID, or other external identifier
department string
position_title string
start_date string (date)
end_date string (date) Leave empty for current affiliation
is_primary boolean
affiliation_type string
Enum: employment, education, visiting, honorary, consulting
created string (date-time)

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/reviewer-profiles/a1b2c3d4-e5f6-7890-abcd-ef1234567890/expertise/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_reviewer_expertise_request import PatchedReviewerExpertiseRequest # (1)
from waldur_api_client.api.reviewer_profiles import nested_reviewer_profile_expertise_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedReviewerExpertiseRequest()
response = nested_reviewer_profile_expertise_partial_update.sync(
    reviewer_profile_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedReviewerExpertiseRequest
  2. API Source: nested_reviewer_profile_expertise_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { nestedReviewerProfileExpertisePartialUpdate } from 'waldur-js-client';

try {
  const response = await nestedReviewerProfileExpertisePartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "reviewer_profile_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
reviewer_profile_uuid string ✓ UUID of the parent reviewer profile
uuid string (uuid) ✓
Field Type Required Description
expertise_keyword string Free-text keyword
expertise_category string (uuid)
proficiency_level string
Enum: expert, familiar, basic
years_experience integer
last_active_date string (date) When last worked in this area

200 -

Field Type Description
uuid string (uuid)
expertise_keyword string Free-text keyword
expertise_category string (uuid)
expertise_category_name string
proficiency_level string
Enum: expert, familiar, basic
years_experience integer
last_active_date string (date) When last worked in this area
created string (date-time)

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/reviewer-profiles/a1b2c3d4-e5f6-7890-abcd-ef1234567890/publications/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_reviewer_publication_request import PatchedReviewerPublicationRequest # (1)
from waldur_api_client.api.reviewer_profiles import nested_reviewer_profile_publications_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedReviewerPublicationRequest()
response = nested_reviewer_profile_publications_partial_update.sync(
    reviewer_profile_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedReviewerPublicationRequest
  2. API Source: nested_reviewer_profile_publications_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { nestedReviewerProfilePublicationsPartialUpdate } from 'waldur-js-client';

try {
  const response = await nestedReviewerProfilePublicationsPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "reviewer_profile_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
reviewer_profile_uuid string ✓ UUID of the parent reviewer profile
uuid string (uuid) ✓
Field Type Required Description
title string
doi string Digital Object Identifier
publication_year integer
venue string Journal or conference name
venue_type string
Enum: journal, conference, preprint, book, thesis, report, other
abstract string
coauthors any List of co-author names and identifiers
external_ids any External identifiers:
is_excluded_from_matching boolean User can exclude old papers from expertise matching

200 -

Field Type Description
uuid string (uuid)
title string
doi string Digital Object Identifier
publication_year integer
venue string Journal or conference name
venue_type string
Enum: journal, conference, preprint, book, thesis, report, other
abstract string
coauthors any List of co-author names and identifiers
external_ids any External identifiers:
is_excluded_from_matching boolean User can exclude old papers from expertise matching
created string (date-time)

Get or create reviewer profile for the current user

Get or create reviewer profile for the current user.

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/reviewer-profiles/me/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_reviewer_profile_create_request import PatchedReviewerProfileCreateRequest # (1)
from waldur_api_client.api.reviewer_profiles import reviewer_profiles_me_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedReviewerProfileCreateRequest()
response = reviewer_profiles_me_partial_update.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedReviewerProfileCreateRequest
  2. API Source: reviewer_profiles_me_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { reviewerProfilesMePartialUpdate } from 'waldur-js-client';

try {
  const response = await reviewerProfilesMePartialUpdate({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
orcid_id string ORCID identifier (format: 0000-0000-0000-0000)
biography string Professional biography / summary
alternative_names any List of name variants used in publications
available_for_reviews boolean Whether reviewer is currently accepting review requests

200 -

Field Type Description
url string (uri)
uuid string (uuid)
user string (uri)
user_uuid string (uuid)
user_full_name string
user_email string (email)
orcid_id string ORCID identifier (format: 0000-0000-0000-0000)
orcid_connected boolean Check if ORCID is connected (has access token).
orcid_last_sync string (date-time)
biography string Professional biography / summary
alternative_names any List of name variants used in publications
affiliations array of objects
affiliations.uuid string (uuid)
affiliations.organization string (uuid)
affiliations.organization_name string Organization name (used when not linked to Waldur org)
affiliations.organization_name_display string Return organization name from linked Customer or from the text field.
affiliations.organization_identifier string ROR, GRID, or other external identifier
affiliations.department string
affiliations.position_title string
affiliations.start_date string (date)
affiliations.end_date string (date) Leave empty for current affiliation
affiliations.is_primary boolean
affiliations.affiliation_type string
Enum: employment, education, visiting, honorary, consulting
affiliations.created string (date-time)
expertise_set array of objects
expertise_set.uuid string (uuid)
expertise_set.expertise_keyword string Free-text keyword
expertise_set.expertise_category string (uuid)
expertise_set.expertise_category_name string
expertise_set.proficiency_level string
Enum: expert, familiar, basic
expertise_set.years_experience integer
expertise_set.last_active_date string (date) When last worked in this area
expertise_set.created string (date-time)
publications array of objects
publications.uuid string (uuid)
publications.title string
publications.doi string Digital Object Identifier
publications.publication_year integer
publications.venue string Journal or conference name
publications.venue_type string
Enum: journal, conference, preprint, book, thesis, report, other
publications.abstract string
publications.coauthors any List of co-author names and identifiers
publications.external_ids any External identifiers:
publications.is_excluded_from_matching boolean User can exclude old papers from expertise matching
publications.created string (date-time)
stats any
profile_completeness object (free-form) Calculate profile completeness percentage and missing fields.
is_published boolean Whether profile is discoverable by call managers
published_at string (date-time) When the profile was published
available_for_reviews boolean Whether reviewer is currently accepting review requests
created string (date-time)
modified string (date-time)

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/reviewer-profiles/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_reviewer_profile_request import PatchedReviewerProfileRequest # (1)
from waldur_api_client.api.reviewer_profiles import reviewer_profiles_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedReviewerProfileRequest()
response = reviewer_profiles_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedReviewerProfileRequest
  2. API Source: reviewer_profiles_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { reviewerProfilesPartialUpdate } from 'waldur-js-client';

try {
  const response = await reviewerProfilesPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
orcid_id string ORCID identifier (format: 0000-0000-0000-0000)
biography string Professional biography / summary
alternative_names any List of name variants used in publications
available_for_reviews boolean Whether reviewer is currently accepting review requests

200 -

Field Type Description
url string (uri)
uuid string (uuid)
user string (uri)
user_uuid string (uuid)
user_full_name string
user_email string (email)
orcid_id string ORCID identifier (format: 0000-0000-0000-0000)
orcid_connected boolean Check if ORCID is connected (has access token).
orcid_last_sync string (date-time)
biography string Professional biography / summary
alternative_names any List of name variants used in publications
affiliations array of objects
affiliations.uuid string (uuid)
affiliations.organization string (uuid)
affiliations.organization_name string Organization name (used when not linked to Waldur org)
affiliations.organization_name_display string Return organization name from linked Customer or from the text field.
affiliations.organization_identifier string ROR, GRID, or other external identifier
affiliations.department string
affiliations.position_title string
affiliations.start_date string (date)
affiliations.end_date string (date) Leave empty for current affiliation
affiliations.is_primary boolean
affiliations.affiliation_type string
Enum: employment, education, visiting, honorary, consulting
affiliations.created string (date-time)
expertise_set array of objects
expertise_set.uuid string (uuid)
expertise_set.expertise_keyword string Free-text keyword
expertise_set.expertise_category string (uuid)
expertise_set.expertise_category_name string
expertise_set.proficiency_level string
Enum: expert, familiar, basic
expertise_set.years_experience integer
expertise_set.last_active_date string (date) When last worked in this area
expertise_set.created string (date-time)
publications array of objects
publications.uuid string (uuid)
publications.title string
publications.doi string Digital Object Identifier
publications.publication_year integer
publications.venue string Journal or conference name
publications.venue_type string
Enum: journal, conference, preprint, book, thesis, report, other
publications.abstract string
publications.coauthors any List of co-author names and identifiers
publications.external_ids any External identifiers:
publications.is_excluded_from_matching boolean User can exclude old papers from expertise matching
publications.created string (date-time)
stats any
profile_completeness object (free-form) Calculate profile completeness percentage and missing fields.
is_published boolean Whether profile is discoverable by call managers
published_at string (date-time) When the profile was published
available_for_reviews boolean Whether reviewer is currently accepting review requests
created string (date-time)
modified string (date-time)

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/reviewer-profiles/a1b2c3d4-e5f6-7890-abcd-ef1234567890/affiliations/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.reviewer_profiles import nested_reviewer_profile_affiliations_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = nested_reviewer_profile_affiliations_destroy.sync(
    reviewer_profile_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: nested_reviewer_profile_affiliations_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { nestedReviewerProfileAffiliationsDestroy } from 'waldur-js-client';

try {
  const response = await nestedReviewerProfileAffiliationsDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "reviewer_profile_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
reviewer_profile_uuid string ✓ UUID of the parent reviewer profile
uuid string (uuid) ✓

204 - No response body

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/reviewer-profiles/a1b2c3d4-e5f6-7890-abcd-ef1234567890/expertise/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.reviewer_profiles import nested_reviewer_profile_expertise_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = nested_reviewer_profile_expertise_destroy.sync(
    reviewer_profile_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: nested_reviewer_profile_expertise_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { nestedReviewerProfileExpertiseDestroy } from 'waldur-js-client';

try {
  const response = await nestedReviewerProfileExpertiseDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "reviewer_profile_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
reviewer_profile_uuid string ✓ UUID of the parent reviewer profile
uuid string (uuid) ✓

204 - No response body

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/reviewer-profiles/a1b2c3d4-e5f6-7890-abcd-ef1234567890/publications/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.reviewer_profiles import nested_reviewer_profile_publications_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = nested_reviewer_profile_publications_destroy.sync(
    reviewer_profile_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: nested_reviewer_profile_publications_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { nestedReviewerProfilePublicationsDestroy } from 'waldur-js-client';

try {
  const response = await nestedReviewerProfilePublicationsDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "reviewer_profile_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
reviewer_profile_uuid string ✓ UUID of the parent reviewer profile
uuid string (uuid) ✓

204 - No response body

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/reviewer-profiles/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.reviewer_profiles import reviewer_profiles_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = reviewer_profiles_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: reviewer_profiles_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { reviewerProfilesDestroy } from 'waldur-js-client';

try {
  const response = await reviewerProfilesDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Reviewer Suggestions

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/reviewer-suggestions/ List Reviewer Suggestions
GET /api/reviewer-suggestions/{uuid}/ Retrieve
DELETE /api/reviewer-suggestions/{uuid}/ Delete a reviewer suggestion
Other Actions
POST /api/reviewer-suggestions/{uuid}/confirm/ Confirm a reviewer suggestion. The reviewer will be invited to the call
POST /api/reviewer-suggestions/{uuid}/reject/ Reject a reviewer suggestion

Core CRUD

List Reviewer Suggestions

1
2
3
4
http \
  GET \
  https://api.example.com/api/reviewer-suggestions/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.reviewer_suggestion_o_enum import ReviewerSuggestionOEnum # (1)
from waldur_api_client.models.reviewer_suggestion_status_enum import ReviewerSuggestionStatusEnum # (2)
from waldur_api_client.api.reviewer_suggestions import reviewer_suggestions_list # (3)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = reviewer_suggestions_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: ReviewerSuggestionOEnum
  2. Model Source: ReviewerSuggestionStatusEnum
  3. API Source: reviewer_suggestions_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { reviewerSuggestionsList } from 'waldur-js-client';

try {
  const response = await reviewerSuggestionsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
call_uuid string (uuid)
min_affinity_score number (float)
o array Ordering
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
reviewer_uuid string (uuid)
status array

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
call string (uri)
call_uuid string (uuid)
call_name string
reviewer string (uri)
reviewer_uuid string (uuid)
reviewer_name string
reviewer_email string (email)
reviewer_biography string Professional biography / summary
affinity_score number (double) Combined affinity score (0-1)
keyword_score number (double) Keyword matching score
text_score number (double) TF-IDF text similarity score
status string
Enum: pending, confirmed, rejected, invited
status_display string
reviewed_by string (uri)
reviewed_by_name string
reviewed_at string (date-time)
rejection_reason string
matched_keywords any Keywords from reviewer's expertise that matched the source text
top_matching_proposals any Top proposals with highest affinity: [{uuid, name, slug, affinity}, ...]
source_type any What content was used to generate this suggestion
source_type_display string
created string (date-time)

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/reviewer-suggestions/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.reviewer_suggestions import reviewer_suggestions_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = reviewer_suggestions_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: reviewer_suggestions_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { reviewerSuggestionsRetrieve } from 'waldur-js-client';

try {
  const response = await reviewerSuggestionsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
url string (uri)
uuid string (uuid)
call string (uri)
call_uuid string (uuid)
call_name string
reviewer string (uri)
reviewer_uuid string (uuid)
reviewer_name string
reviewer_email string (email)
reviewer_biography string Professional biography / summary
affinity_score number (double) Combined affinity score (0-1)
keyword_score number (double) Keyword matching score
text_score number (double) TF-IDF text similarity score
status string
Enum: pending, confirmed, rejected, invited
status_display string
reviewed_by string (uri)
reviewed_by_name string
reviewed_at string (date-time)
rejection_reason string
matched_keywords any Keywords from reviewer's expertise that matched the source text
top_matching_proposals any Top proposals with highest affinity: [{uuid, name, slug, affinity}, ...]
source_type any What content was used to generate this suggestion
source_type_display string
created string (date-time)

Delete a reviewer suggestion

Delete a reviewer suggestion.

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/reviewer-suggestions/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.reviewer_suggestions import reviewer_suggestions_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = reviewer_suggestions_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: reviewer_suggestions_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { reviewerSuggestionsDestroy } from 'waldur-js-client';

try {
  const response = await reviewerSuggestionsDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Other Actions

Confirm a reviewer suggestion. The reviewer will be invited to the call

Confirm a reviewer suggestion. The reviewer will be invited to the call.

1
2
3
4
http \
  POST \
  https://api.example.com/api/reviewer-suggestions/a1b2c3d4-e5f6-7890-abcd-ef1234567890/confirm/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.reviewer_suggestion_request import ReviewerSuggestionRequest # (1)
from waldur_api_client.api.reviewer_suggestions import reviewer_suggestions_confirm # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ReviewerSuggestionRequest()
response = reviewer_suggestions_confirm.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ReviewerSuggestionRequest
  2. API Source: reviewer_suggestions_confirm
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { reviewerSuggestionsConfirm } from 'waldur-js-client';

try {
  const response = await reviewerSuggestionsConfirm({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
status string
rejection_reason string

200 -

Field Type Description
url string (uri)
uuid string (uuid)
call string (uri)
call_uuid string (uuid)
call_name string
reviewer string (uri)
reviewer_uuid string (uuid)
reviewer_name string
reviewer_email string (email)
reviewer_biography string Professional biography / summary
affinity_score number (double) Combined affinity score (0-1)
keyword_score number (double) Keyword matching score
text_score number (double) TF-IDF text similarity score
status string
Enum: pending, confirmed, rejected, invited
status_display string
reviewed_by string (uri)
reviewed_by_name string
reviewed_at string (date-time)
rejection_reason string
matched_keywords any Keywords from reviewer's expertise that matched the source text
top_matching_proposals any Top proposals with highest affinity: [{uuid, name, slug, affinity}, ...]
source_type any What content was used to generate this suggestion
source_type_display string
created string (date-time)

Reject a reviewer suggestion

Reject a reviewer suggestion.

1
2
3
4
http \
  POST \
  https://api.example.com/api/reviewer-suggestions/a1b2c3d4-e5f6-7890-abcd-ef1234567890/reject/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.suggestion_reject_request import SuggestionRejectRequest # (1)
from waldur_api_client.api.reviewer_suggestions import reviewer_suggestions_reject # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = SuggestionRejectRequest()
response = reviewer_suggestions_reject.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: SuggestionRejectRequest
  2. API Source: reviewer_suggestions_reject
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { reviewerSuggestionsReject } from 'waldur-js-client';

try {
  const response = await reviewerSuggestionsReject({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
reason string Reason for rejecting the suggestion

200 -

Field Type Description
url string (uri)
uuid string (uuid)
call string (uri)
call_uuid string (uuid)
call_name string
reviewer string (uri)
reviewer_uuid string (uuid)
reviewer_name string
reviewer_email string (email)
reviewer_biography string Professional biography / summary
affinity_score number (double) Combined affinity score (0-1)
keyword_score number (double) Keyword matching score
text_score number (double) TF-IDF text similarity score
status string
Enum: pending, confirmed, rejected, invited
status_display string
reviewed_by string (uri)
reviewed_by_name string
reviewed_at string (date-time)
rejection_reason string
matched_keywords any Keywords from reviewer's expertise that matched the source text
top_matching_proposals any Top proposals with highest affinity: [{uuid, name, slug, affinity}, ...]
source_type any What content was used to generate this suggestion
source_type_display string
created string (date-time)

Proposal Reviews

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/proposal-reviews/ List Proposal Reviews
GET /api/proposal-reviews/{uuid}/ Retrieve
POST /api/proposal-reviews/ Create
PUT /api/proposal-reviews/{uuid}/ Update
PATCH /api/proposal-reviews/{uuid}/ Partial Update
DELETE /api/proposal-reviews/{uuid}/ Delete
Other Actions
POST /api/proposal-reviews/{uuid}/reject/ Reject a review, changing its state to REJECTED
POST /api/proposal-reviews/{uuid}/submit/ Submit a review, changing its state to SUBMITTED

Core CRUD

List Proposal Reviews

1
2
3
4
http \
  GET \
  https://api.example.com/api/proposal-reviews/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.proposal_review_o_enum import ProposalReviewOEnum # (1)
from waldur_api_client.models.proposal_review_state_enum import ProposalReviewStateEnum # (2)
from waldur_api_client.api.proposal_reviews import proposal_reviews_list # (3)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = proposal_reviews_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: ProposalReviewOEnum
  2. Model Source: ProposalReviewStateEnum
  3. API Source: proposal_reviews_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { proposalReviewsList } from 'waldur-js-client';

try {
  const response = await proposalReviewsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
call_uuid string (uuid)
o array Ordering
organization_uuid string (uuid)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
proposal string (uri)
proposal_name string
proposal_uuid string (uuid)
reviewer_uuid string (uuid)
round_uuid string (uuid)
state array

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
proposal string (uri)
proposal_name string
proposal_uuid string (uuid)
proposal_slug string
reviewer string (uri)
reviewer_full_name string
reviewer_uuid string (uuid)
anonymous_reviewer_name string Generate an anonymous reviewer identifier like 'Reviewer 1', 'Reviewer 2'. Returns None if the review is not associated with a proposal.
state any
review_end_date string (date-time)
summary_score integer
summary_public_comment string
summary_private_comment string
round_uuid string (uuid)
round_name string
round_slug string
round_cutoff_time string (date-time)
round_start_time string (date-time)
call_name string
call_uuid string (uuid)
call_slug string
call_managing_organisation_uuid string (uuid)
comment_project_title string
comment_project_summary string
comment_project_is_confidential string
comment_project_has_civilian_purpose string
comment_project_description string
comment_project_duration string
comment_project_supporting_documentation string
comment_resource_requests string
comment_team string
created string (date-time)
modified string (date-time)

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/proposal-reviews/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.proposal_reviews import proposal_reviews_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = proposal_reviews_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: proposal_reviews_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { proposalReviewsRetrieve } from 'waldur-js-client';

try {
  const response = await proposalReviewsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
url string (uri)
uuid string (uuid)
proposal string (uri)
proposal_name string
proposal_uuid string (uuid)
proposal_slug string
reviewer string (uri)
reviewer_full_name string
reviewer_uuid string (uuid)
anonymous_reviewer_name string Generate an anonymous reviewer identifier like 'Reviewer 1', 'Reviewer 2'. Returns None if the review is not associated with a proposal.
state any
review_end_date string (date-time)
summary_score integer
summary_public_comment string
summary_private_comment string
round_uuid string (uuid)
round_name string
round_slug string
round_cutoff_time string (date-time)
round_start_time string (date-time)
call_name string
call_uuid string (uuid)
call_slug string
call_managing_organisation_uuid string (uuid)
comment_project_title string
comment_project_summary string
comment_project_is_confidential string
comment_project_has_civilian_purpose string
comment_project_description string
comment_project_duration string
comment_project_supporting_documentation string
comment_resource_requests string
comment_team string
created string (date-time)
modified string (date-time)

Create

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/proposal-reviews/ \
  Authorization:"Token YOUR_API_TOKEN" \
  proposal="https://api.example.com/api/proposal/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.proposal_review_request import ProposalReviewRequest # (1)
from waldur_api_client.api.proposal_reviews import proposal_reviews_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ProposalReviewRequest(
    proposal="https://api.example.com/api/proposal/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = proposal_reviews_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ProposalReviewRequest
  2. API Source: proposal_reviews_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { proposalReviewsCreate } from 'waldur-js-client';

try {
  const response = await proposalReviewsCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "proposal": "https://api.example.com/api/proposal/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required
proposal string (uri) ✓
reviewer string (uri)
summary_score integer
summary_public_comment string
summary_private_comment string
comment_project_title string
comment_project_summary string
comment_project_is_confidential string
comment_project_has_civilian_purpose string
comment_project_description string
comment_project_duration string
comment_project_supporting_documentation string
comment_resource_requests string
comment_team string

201 -

Field Type Description
url string (uri)
uuid string (uuid)
proposal string (uri)
proposal_name string
proposal_uuid string (uuid)
proposal_slug string
reviewer string (uri)
reviewer_full_name string
reviewer_uuid string (uuid)
anonymous_reviewer_name string Generate an anonymous reviewer identifier like 'Reviewer 1', 'Reviewer 2'. Returns None if the review is not associated with a proposal.
state any
review_end_date string (date-time)
summary_score integer
summary_public_comment string
summary_private_comment string
round_uuid string (uuid)
round_name string
round_slug string
round_cutoff_time string (date-time)
round_start_time string (date-time)
call_name string
call_uuid string (uuid)
call_slug string
call_managing_organisation_uuid string (uuid)
comment_project_title string
comment_project_summary string
comment_project_is_confidential string
comment_project_has_civilian_purpose string
comment_project_description string
comment_project_duration string
comment_project_supporting_documentation string
comment_resource_requests string
comment_team string
created string (date-time)
modified string (date-time)

Update

1
2
3
4
5
http \
  PUT \
  https://api.example.com/api/proposal-reviews/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  proposal="https://api.example.com/api/proposal/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.proposal_review_request import ProposalReviewRequest # (1)
from waldur_api_client.api.proposal_reviews import proposal_reviews_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ProposalReviewRequest(
    proposal="https://api.example.com/api/proposal/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = proposal_reviews_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ProposalReviewRequest
  2. API Source: proposal_reviews_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { proposalReviewsUpdate } from 'waldur-js-client';

try {
  const response = await proposalReviewsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "proposal": "https://api.example.com/api/proposal/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
proposal string (uri) ✓
reviewer string (uri)
summary_score integer
summary_public_comment string
summary_private_comment string
comment_project_title string
comment_project_summary string
comment_project_is_confidential string
comment_project_has_civilian_purpose string
comment_project_description string
comment_project_duration string
comment_project_supporting_documentation string
comment_resource_requests string
comment_team string

200 -

Field Type Description
url string (uri)
uuid string (uuid)
proposal string (uri)
proposal_name string
proposal_uuid string (uuid)
proposal_slug string
reviewer string (uri)
reviewer_full_name string
reviewer_uuid string (uuid)
anonymous_reviewer_name string Generate an anonymous reviewer identifier like 'Reviewer 1', 'Reviewer 2'. Returns None if the review is not associated with a proposal.
state any
review_end_date string (date-time)
summary_score integer
summary_public_comment string
summary_private_comment string
round_uuid string (uuid)
round_name string
round_slug string
round_cutoff_time string (date-time)
round_start_time string (date-time)
call_name string
call_uuid string (uuid)
call_slug string
call_managing_organisation_uuid string (uuid)
comment_project_title string
comment_project_summary string
comment_project_is_confidential string
comment_project_has_civilian_purpose string
comment_project_description string
comment_project_duration string
comment_project_supporting_documentation string
comment_resource_requests string
comment_team string
created string (date-time)
modified string (date-time)

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/proposal-reviews/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_proposal_review_request import PatchedProposalReviewRequest # (1)
from waldur_api_client.api.proposal_reviews import proposal_reviews_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedProposalReviewRequest()
response = proposal_reviews_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedProposalReviewRequest
  2. API Source: proposal_reviews_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { proposalReviewsPartialUpdate } from 'waldur-js-client';

try {
  const response = await proposalReviewsPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
summary_score integer
summary_public_comment string
summary_private_comment string
comment_project_title string
comment_project_summary string
comment_project_is_confidential string
comment_project_has_civilian_purpose string
comment_project_description string
comment_project_duration string
comment_project_supporting_documentation string
comment_resource_requests string
comment_team string

200 -

Field Type Description
url string (uri)
uuid string (uuid)
proposal string (uri)
proposal_name string
proposal_uuid string (uuid)
proposal_slug string
reviewer string (uri)
reviewer_full_name string
reviewer_uuid string (uuid)
anonymous_reviewer_name string Generate an anonymous reviewer identifier like 'Reviewer 1', 'Reviewer 2'. Returns None if the review is not associated with a proposal.
state any
review_end_date string (date-time)
summary_score integer
summary_public_comment string
summary_private_comment string
round_uuid string (uuid)
round_name string
round_slug string
round_cutoff_time string (date-time)
round_start_time string (date-time)
call_name string
call_uuid string (uuid)
call_slug string
call_managing_organisation_uuid string (uuid)
comment_project_title string
comment_project_summary string
comment_project_is_confidential string
comment_project_has_civilian_purpose string
comment_project_description string
comment_project_duration string
comment_project_supporting_documentation string
comment_resource_requests string
comment_team string
created string (date-time)
modified string (date-time)

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/proposal-reviews/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.proposal_reviews import proposal_reviews_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = proposal_reviews_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: proposal_reviews_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { proposalReviewsDestroy } from 'waldur-js-client';

try {
  const response = await proposalReviewsDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Other Actions

Reject a review, changing its state to REJECTED

Reject a review, changing its state to REJECTED.

1
2
3
4
http \
  POST \
  https://api.example.com/api/proposal-reviews/a1b2c3d4-e5f6-7890-abcd-ef1234567890/reject/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.proposal_reviews import proposal_reviews_reject # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = proposal_reviews_reject.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: proposal_reviews_reject
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { proposalReviewsReject } from 'waldur-js-client';

try {
  const response = await proposalReviewsReject({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 - No response body

Submit a review, changing its state to SUBMITTED

Submit a review, changing its state to SUBMITTED.

1
2
3
4
http \
  POST \
  https://api.example.com/api/proposal-reviews/a1b2c3d4-e5f6-7890-abcd-ef1234567890/submit/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.review_submit_request import ReviewSubmitRequest # (1)
from waldur_api_client.api.proposal_reviews import proposal_reviews_submit # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ReviewSubmitRequest()
response = proposal_reviews_submit.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ReviewSubmitRequest
  2. API Source: proposal_reviews_submit
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { proposalReviewsSubmit } from 'waldur-js-client';

try {
  const response = await proposalReviewsSubmit({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
summary_score integer
summary_public_comment string
summary_private_comment string

200 - No response body

Support and operations

Feedback and statistics

Support Feedback Average Report

Operations Summary

Method Endpoint Description
GET /api/support-feedback-average-report/ List Support Feedback Average Report

List Support Feedback Average Report

1
2
3
4
http \
  GET \
  https://api.example.com/api/support-feedback-average-report/ \
  Authorization:"Token YOUR_API_TOKEN"

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.support_feedback_average_report import support_feedback_average_report_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = support_feedback_average_report_retrieve.sync(client=client)

print(response)
  1. API Source: support_feedback_average_report_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { supportFeedbackAverageReportRetrieve } from 'waldur-js-client';

try {
  const response = await supportFeedbackAverageReportRetrieve({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

200 - No response body

Support Feedback Report

Operations Summary

Method Endpoint Description
GET /api/support-feedback-report/ List Support Feedback Report

List Support Feedback Report

1
2
3
4
http \
  GET \
  https://api.example.com/api/support-feedback-report/ \
  Authorization:"Token YOUR_API_TOKEN"

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.support_feedback_report import support_feedback_report_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = support_feedback_report_retrieve.sync(client=client)

print(response)
  1. API Source: support_feedback_report_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { supportFeedbackReportRetrieve } from 'waldur-js-client';

try {
  const response = await supportFeedbackReportRetrieve({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

200 - No response body

Support Feedbacks

Operations Summary

Method Endpoint Description
GET /api/support-feedbacks/ List Support Feedbacks
GET /api/support-feedbacks/{uuid}/ Retrieve
POST /api/support-feedbacks/ Create

List Support Feedbacks

1
2
3
4
http \
  GET \
  https://api.example.com/api/support-feedbacks/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.support_feedbacks import support_feedbacks_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = support_feedbacks_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: support_feedbacks_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { supportFeedbacksList } from 'waldur-js-client';

try {
  const response = await supportFeedbacksList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
created_after string (date-time)
created_before string (date-time)
evaluation integer
issue string (uri)
issue_key string
issue_uuid string (uuid)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
user string (uri)
user_full_name string User full name contains
user_uuid string (uuid)

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
uuid string (uuid)
created string (date-time)
modified string (date-time)
state any
evaluation integer
comment string
issue_uuid string (uuid)
user_full_name string
issue_key string
issue_summary string

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/support-feedbacks/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.support_feedbacks import support_feedbacks_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = support_feedbacks_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: support_feedbacks_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { supportFeedbacksRetrieve } from 'waldur-js-client';

try {
  const response = await supportFeedbacksRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
uuid string (uuid)
created string (date-time)
modified string (date-time)
state any
evaluation integer
comment string
issue_uuid string (uuid)
user_full_name string
issue_key string
issue_summary string

Create

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/support-feedbacks/ \
  Authorization:"Token YOUR_API_TOKEN" \
  evaluation=123 \
  token="********"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.create_feedback_request import CreateFeedbackRequest # (1)
from waldur_api_client.api.support_feedbacks import support_feedbacks_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = CreateFeedbackRequest(
    evaluation=123,
    token="********"
)
response = support_feedbacks_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: CreateFeedbackRequest
  2. API Source: support_feedbacks_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { supportFeedbacksCreate } from 'waldur-js-client';

try {
  const response = await supportFeedbacksCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "evaluation": 123,
    "token": "********"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required
comment string
evaluation integer ✓
token string ✓

201 -

Field Type
uuid string (uuid)
issue string (uri)
comment string
evaluation integer

Support Statistics

Operations Summary

Method Endpoint Description
GET /api/support-statistics/ List Support Statistics

List Support Statistics

1
2
3
4
http \
  GET \
  https://api.example.com/api/support-statistics/ \
  Authorization:"Token YOUR_API_TOKEN"

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.support_statistics import support_statistics_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = support_statistics_retrieve.sync(client=client)

print(response)
  1. API Source: support_statistics_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { supportStatisticsRetrieve } from 'waldur-js-client';

try {
  const response = await supportStatisticsRetrieve({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

200 -

Field Type
open_issues_count integer
closed_this_month_count integer
recent_broadcasts_count integer

Support and issues

Support Attachments

Operations Summary

Method Endpoint Description
GET /api/support-attachments/ List Support Attachments
GET /api/support-attachments/{uuid}/ Retrieve
POST /api/support-attachments/ Create
DELETE /api/support-attachments/{uuid}/ Delete

List Support Attachments

1
2
3
4
http \
  GET \
  https://api.example.com/api/support-attachments/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.attachment_field_enum import AttachmentFieldEnum # (1)
from waldur_api_client.api.support_attachments import support_attachments_list # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = support_attachments_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: AttachmentFieldEnum
  2. API Source: support_attachments_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { supportAttachmentsList } from 'waldur-js-client';

try {
  const response = await supportAttachmentsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
field array
issue string (uri)
issue_uuid string (uuid)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
url string (uri)
uuid string (uuid)
issue string (uri)
issue_key string
created string (date-time)
file string (uri)
mime_type string
file_size integer
file_name string
backend_id string
destroy_is_available boolean

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/support-attachments/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.attachment_field_enum import AttachmentFieldEnum # (1)
from waldur_api_client.api.support_attachments import support_attachments_retrieve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = support_attachments_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. Model Source: AttachmentFieldEnum
  2. API Source: support_attachments_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { supportAttachmentsRetrieve } from 'waldur-js-client';

try {
  const response = await supportAttachmentsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type
field array

200 -

Field Type
url string (uri)
uuid string (uuid)
issue string (uri)
issue_key string
created string (date-time)
file string (uri)
mime_type string
file_size integer
file_name string
backend_id string
destroy_is_available boolean

Create

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/support-attachments/ \
  Authorization:"Token YOUR_API_TOKEN" \
  issue="https://api.example.com/api/issue/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  file="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.attachment_request import AttachmentRequest # (1)
from waldur_api_client.api.support_attachments import support_attachments_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = AttachmentRequest(
    issue="https://api.example.com/api/issue/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    file="string-value"
)
response = support_attachments_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: AttachmentRequest
  2. API Source: support_attachments_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { supportAttachmentsCreate } from 'waldur-js-client';

try {
  const response = await supportAttachmentsCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "issue": "https://api.example.com/api/issue/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "file": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required
issue string (uri) ✓
file string (binary) ✓

201 -

Field Type
url string (uri)
uuid string (uuid)
issue string (uri)
issue_key string
created string (date-time)
file string (uri)
mime_type string
file_size integer
file_name string
backend_id string
destroy_is_available boolean

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/support-attachments/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.support_attachments import support_attachments_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = support_attachments_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: support_attachments_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { supportAttachmentsDestroy } from 'waldur-js-client';

try {
  const response = await supportAttachmentsDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Chat Quota

Operations Summary

Method Endpoint Description
GET /api/chat-quota/usage/ List Chat Quota Usage
POST /api/chat-quota/set_quota/ Set token quota for user

List Chat Quota Usage

1
2
3
4
5
6
7
8
    Get current token quota and usage for the requesting user.

    Returns token quota for all periods (daily, weekly, monthly):
    - limit: User's custom limit (null = use system default, -1 = unlimited, or positive integer)
    - usage: Tokens used in current period
    - remaining: Tokens remaining (null if unlimited)
    - reset_at: When the period resets
    - system_default: System-wide default limit from configuration (for transparency when limit is null)

1
2
3
4
5
http \
  GET \
  https://api.example.com/api/chat-quota/usage/ \
  Authorization:"Token YOUR_API_TOKEN" \
  user_uuid=="a1b2c3d4-e5f6-7890-abcd-ef1234567890"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.chat_quota import chat_quota_usage_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = chat_quota_usage_retrieve.sync(
    client=client,
    user_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
)

print(response)
  1. API Source: chat_quota_usage_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { chatQuotaUsageRetrieve } from 'waldur-js-client';

try {
  const response = await chatQuotaUsageRetrieve({
  auth: "Token YOUR_API_TOKEN",
  query: {
    "user_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
user_uuid string (uuid) ✓ UUID of user to view quota for (staff/support only). Omit to view your own quota.

200 -

Field Type Description
daily_limit integer Daily token limit (non-negative integer). Null uses system default. -1 means unlimited.
daily_usage integer
daily_remaining integer Get remaining daily tokens.
daily_reset_at string (date-time) Calculate next midnight (00:00:00).
daily_system_default integer Get system default daily token limit from constance config.
weekly_limit integer Weekly token limit (non-negative integer). Null uses system default. -1 means unlimited.
weekly_usage integer
weekly_remaining integer Get remaining weekly tokens.
weekly_reset_at string (date-time) Calculate next Monday at midnight.
weekly_system_default integer Get system default weekly token limit from constance config.
monthly_limit integer Monthly token limit (non-negative integer). Null uses system default. -1 means unlimited.
monthly_usage integer
monthly_remaining integer Get remaining monthly tokens.
monthly_reset_at string (date-time) Calculate first day of next month at midnight.
monthly_system_default integer Get system default monthly token limit from constance config.

Set token quota for user

Allows staff/support to set token quota limits for a specific user. Configure daily, weekly, and monthly limits: - Omit field or send null: Use system default - -1: Unlimited (no quota enforcement) - 0 or positive integer: Specific token limit

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/chat-quota/set_quota/ \
  Authorization:"Token YOUR_API_TOKEN" \
  user_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.set_token_quota_request import SetTokenQuotaRequest # (1)
from waldur_api_client.api.chat_quota import chat_quota_set_quota # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = SetTokenQuotaRequest(
    user_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
)
response = chat_quota_set_quota.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: SetTokenQuotaRequest
  2. API Source: chat_quota_set_quota
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { chatQuotaSetQuota } from 'waldur-js-client';

try {
  const response = await chatQuotaSetQuota({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "user_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
user_uuid string (uuid) ✓ UUID of the user to set quota for.
daily_limit integer Daily token limit. Omit or null = system default, -1 = unlimited.
weekly_limit integer Weekly token limit. Omit or null = system default, -1 = unlimited.
monthly_limit integer Monthly token limit. Omit or null = system default, -1 = unlimited.

200 - No response body

Chat Tools

Operations Summary

Method Endpoint Description
POST /api/chat-tools/execute/ Execute a tool and return the result

Execute a tool and return the result

Execute a tool and return the result.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/chat-tools/execute/ \
  Authorization:"Token YOUR_API_TOKEN" \
  tool="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.tool_execute_request import ToolExecuteRequest # (1)
from waldur_api_client.api.chat_tools import chat_tools_execute # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ToolExecuteRequest(
    tool="string-value"
)
response = chat_tools_execute.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ToolExecuteRequest
  2. API Source: chat_tools_execute
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { chatToolsExecute } from 'waldur-js-client';

try {
  const response = await chatToolsExecute({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "tool": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
tool string ✓ Name of the tool to execute.
arguments any Tool arguments.

200 -

Chat

Operations Summary

Method Endpoint Description
GET /api/chat-messages/ List Chat Messages
GET /api/chat-sessions/current/ Get or create current user's chat session
GET /api/chat-sessions/ List Chat Sessions
GET /api/chat-sessions/{uuid}/ Retrieve
GET /api/chat-threads/ List Chat Threads
GET /api/chat-threads/{uuid}/ Retrieve
POST /api/chat/stream/ Stream
POST /api/chat-threads/{uuid}/archive/ Archive thread
POST /api/chat-threads/{uuid}/unarchive/ Unarchive thread

List Chat Messages

1
2
3
4
http \
  GET \
  https://api.example.com/api/chat-messages/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.chat_messages import chat_messages_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = chat_messages_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: chat_messages_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { chatMessagesList } from 'waldur-js-client';

try {
  const response = await chatMessagesList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type
include_history boolean
is_flagged boolean
thread string (uuid)

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
uuid string (uuid)
thread string (uuid)
role any
content string
sequence_index integer
replaces string (uuid)
created string (date-time)
is_flagged boolean
injection_score number (double)
injection_severity any
injection_categories any

Get or create current user's chat session

Returns the current user's chat session, creating it if it doesn't exist.

1
2
3
4
http \
  GET \
  https://api.example.com/api/chat-sessions/current/ \
  Authorization:"Token YOUR_API_TOKEN"

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.chat_sessions import chat_sessions_current_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = chat_sessions_current_retrieve.sync(client=client)

print(response)
  1. API Source: chat_sessions_current_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { chatSessionsCurrentRetrieve } from 'waldur-js-client';

try {
  const response = await chatSessionsCurrentRetrieve({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

200 -

Field Type
uuid string (uuid)
user string (uuid)
user_username string
user_full_name string
created string (date-time)
modified string (date-time)

List Chat Sessions

1
2
3
4
http \
  GET \
  https://api.example.com/api/chat-sessions/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.chat_session_field_enum import ChatSessionFieldEnum # (1)
from waldur_api_client.api.chat_sessions import chat_sessions_list # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = chat_sessions_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: ChatSessionFieldEnum
  2. API Source: chat_sessions_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { chatSessionsList } from 'waldur-js-client';

try {
  const response = await chatSessionsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
field array
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
uuid string (uuid)
user string (uuid)
user_username string
user_full_name string
created string (date-time)
modified string (date-time)

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/chat-sessions/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.chat_session_field_enum import ChatSessionFieldEnum # (1)
from waldur_api_client.api.chat_sessions import chat_sessions_retrieve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = chat_sessions_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. Model Source: ChatSessionFieldEnum
  2. API Source: chat_sessions_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { chatSessionsRetrieve } from 'waldur-js-client';

try {
  const response = await chatSessionsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type
field array

200 -

Field Type
uuid string (uuid)
user string (uuid)
user_username string
user_full_name string
created string (date-time)
modified string (date-time)

List Chat Threads

1
2
3
4
http \
  GET \
  https://api.example.com/api/chat-threads/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.injection_severity_enum import InjectionSeverityEnum # (1)
from waldur_api_client.models.thread_session_field_enum import ThreadSessionFieldEnum # (2)
from waldur_api_client.models.thread_session_o_enum import ThreadSessionOEnum # (3)
from waldur_api_client.api.chat_threads import chat_threads_list # (4)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = chat_threads_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: InjectionSeverityEnum
  2. Model Source: ThreadSessionFieldEnum
  3. Model Source: ThreadSessionOEnum
  4. API Source: chat_threads_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { chatThreadsList } from 'waldur-js-client';

try {
  const response = await chatThreadsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
created string (date)
field array
is_archived boolean
is_flagged boolean
max_severity string Enum: none, low, medium, high, critical
modified string (date)
o array Ordering
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
query string
user string (uuid)

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
uuid string (uuid)
name string
chat_session string (uuid)
flags any
is_archived boolean
message_count integer
is_flagged boolean
max_severity any
user_username string
user_full_name string
created string (date-time)
modified string (date-time)

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/chat-threads/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.thread_session_field_enum import ThreadSessionFieldEnum # (1)
from waldur_api_client.api.chat_threads import chat_threads_retrieve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = chat_threads_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. Model Source: ThreadSessionFieldEnum
  2. API Source: chat_threads_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { chatThreadsRetrieve } from 'waldur-js-client';

try {
  const response = await chatThreadsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type
field array

200 -

Field Type
uuid string (uuid)
name string
chat_session string (uuid)
flags any
is_archived boolean
message_count integer
is_flagged boolean
max_severity any
user_username string
user_full_name string
created string (date-time)
modified string (date-time)

Stream

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/chat/stream/ \
  Authorization:"Token YOUR_API_TOKEN" \
  input="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.chat_request_request import ChatRequestRequest # (1)
from waldur_api_client.api.chat import chat_stream # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ChatRequestRequest(
    input="string-value"
)
response = chat_stream.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ChatRequestRequest
  2. API Source: chat_stream
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { chatStream } from 'waldur-js-client';

try {
  const response = await chatStream({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "input": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
input string ✓ User input text for the chat model.
thread_uuid string (uuid) Existing thread UUID. If omitted, a new thread is created.
update_thread_name string (uuid) Thread UUID whose name should be set to the assistant's response. Skips message persistence for this call.
mode any 'reload': replace the last assistant response. 'edit': edit a user message and re-stream. Omit for normal new-message behavior.
edit_message_uuid string (uuid) UUID of the user message to edit. Required when mode='edit'.

200 -

Archive thread

Archive a thread (soft delete).

1
2
3
4
http \
  POST \
  https://api.example.com/api/chat-threads/a1b2c3d4-e5f6-7890-abcd-ef1234567890/archive/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.thread_session_request import ThreadSessionRequest # (1)
from waldur_api_client.api.chat_threads import chat_threads_archive # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ThreadSessionRequest()
response = chat_threads_archive.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ThreadSessionRequest
  2. API Source: chat_threads_archive
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { chatThreadsArchive } from 'waldur-js-client';

try {
  const response = await chatThreadsArchive({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
name string
is_archived boolean

204 - No response body

Unarchive thread

Restore an archived thread.

1
2
3
4
http \
  POST \
  https://api.example.com/api/chat-threads/a1b2c3d4-e5f6-7890-abcd-ef1234567890/unarchive/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.thread_session_request import ThreadSessionRequest # (1)
from waldur_api_client.api.chat_threads import chat_threads_unarchive # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ThreadSessionRequest()
response = chat_threads_unarchive.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ThreadSessionRequest
  2. API Source: chat_threads_unarchive
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { chatThreadsUnarchive } from 'waldur-js-client';

try {
  const response = await chatThreadsUnarchive({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
name string
is_archived boolean

204 - No response body

Support Comments

Operations Summary

Method Endpoint Description
GET /api/support-comments/ List Support Comments
GET /api/support-comments/{uuid}/ Retrieve
PUT /api/support-comments/{uuid}/ Update
PATCH /api/support-comments/{uuid}/ Partial Update
DELETE /api/support-comments/{uuid}/ Delete

List Support Comments

1
2
3
4
http \
  GET \
  https://api.example.com/api/support-comments/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.thread_session_o_enum import ThreadSessionOEnum # (1)
from waldur_api_client.api.support_comments import support_comments_list # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = support_comments_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: ThreadSessionOEnum
  2. API Source: support_comments_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { supportCommentsList } from 'waldur-js-client';

try {
  const response = await supportCommentsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
author_name string
author_user string (uri)
description string
is_public boolean
issue string (uri)
issue_uuid string (uuid)
o array Ordering
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
remote_id_is_set boolean Remote ID is set.
resource string (uri) Filter by resource URL.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
url string (uri)
uuid string (uuid)
issue string (uri)
issue_key string
description string
is_public boolean
author_name string
author_uuid string (uuid)
author_user string (uri)
author_email string (email)
backend_id string
remote_id string
created string (date-time)
update_is_available boolean
destroy_is_available boolean

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/support-comments/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.support_comments import support_comments_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = support_comments_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: support_comments_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { supportCommentsRetrieve } from 'waldur-js-client';

try {
  const response = await supportCommentsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
url string (uri)
uuid string (uuid)
issue string (uri)
issue_key string
description string
is_public boolean
author_name string
author_uuid string (uuid)
author_user string (uri)
author_email string (email)
backend_id string
remote_id string
created string (date-time)
update_is_available boolean
destroy_is_available boolean

Update

1
2
3
4
5
http \
  PUT \
  https://api.example.com/api/support-comments/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  description="A sample description."

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.comment_request import CommentRequest # (1)
from waldur_api_client.api.support_comments import support_comments_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = CommentRequest(
    description="A sample description."
)
response = support_comments_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: CommentRequest
  2. API Source: support_comments_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { supportCommentsUpdate } from 'waldur-js-client';

try {
  const response = await supportCommentsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "description": "A sample description."
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
description string ✓
is_public boolean

200 -

Field Type
url string (uri)
uuid string (uuid)
issue string (uri)
issue_key string
description string
is_public boolean
author_name string
author_uuid string (uuid)
author_user string (uri)
author_email string (email)
backend_id string
remote_id string
created string (date-time)
update_is_available boolean
destroy_is_available boolean

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/support-comments/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_comment_request import PatchedCommentRequest # (1)
from waldur_api_client.api.support_comments import support_comments_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedCommentRequest()
response = support_comments_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedCommentRequest
  2. API Source: support_comments_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { supportCommentsPartialUpdate } from 'waldur-js-client';

try {
  const response = await supportCommentsPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
description string
is_public boolean

200 -

Field Type
url string (uri)
uuid string (uuid)
issue string (uri)
issue_key string
description string
is_public boolean
author_name string
author_uuid string (uuid)
author_user string (uri)
author_email string (email)
backend_id string
remote_id string
created string (date-time)
update_is_available boolean
destroy_is_available boolean

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/support-comments/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.support_comments import support_comments_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = support_comments_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: support_comments_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { supportCommentsDestroy } from 'waldur-js-client';

try {
  const response = await supportCommentsDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Support Issue Statuses

Operations Summary

Method Endpoint Description
GET /api/support-issue-statuses/ List Support Issue Statuses
GET /api/support-issue-statuses/{uuid}/ Retrieve
POST /api/support-issue-statuses/ Create
PUT /api/support-issue-statuses/{uuid}/ Update
PATCH /api/support-issue-statuses/{uuid}/ Partial Update
DELETE /api/support-issue-statuses/{uuid}/ Delete

List Support Issue Statuses

1
2
3
4
http \
  GET \
  https://api.example.com/api/support-issue-statuses/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.support_issue_statuses import support_issue_statuses_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = support_issue_statuses_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: support_issue_statuses_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { supportIssueStatusesList } from 'waldur-js-client';

try {
  const response = await supportIssueStatusesList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
name string Status name in Jira.
type any
type_display string

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/support-issue-statuses/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.support_issue_statuses import support_issue_statuses_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = support_issue_statuses_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: support_issue_statuses_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { supportIssueStatusesRetrieve } from 'waldur-js-client';

try {
  const response = await supportIssueStatusesRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string Status name in Jira.
type any
type_display string

Create

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/support-issue-statuses/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-support-issue-status"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.issue_status_create_request import IssueStatusCreateRequest # (1)
from waldur_api_client.api.support_issue_statuses import support_issue_statuses_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = IssueStatusCreateRequest(
    name="my-awesome-support-issue-status"
)
response = support_issue_statuses_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: IssueStatusCreateRequest
  2. API Source: support_issue_statuses_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { supportIssueStatusesCreate } from 'waldur-js-client';

try {
  const response = await supportIssueStatusesCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "name": "my-awesome-support-issue-status"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
name string ✓ Status name in Jira.
type any

201 -

Field Type Description
name string Status name in Jira.
type any

Update

1
2
3
4
5
http \
  PUT \
  https://api.example.com/api/support-issue-statuses/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-support-issue-status"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.issue_status_create_request import IssueStatusCreateRequest # (1)
from waldur_api_client.api.support_issue_statuses import support_issue_statuses_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = IssueStatusCreateRequest(
    name="my-awesome-support-issue-status"
)
response = support_issue_statuses_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: IssueStatusCreateRequest
  2. API Source: support_issue_statuses_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { supportIssueStatusesUpdate } from 'waldur-js-client';

try {
  const response = await supportIssueStatusesUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-support-issue-status"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
name string ✓ Status name in Jira.
type any

200 -

Field Type Description
name string Status name in Jira.
type any

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/support-issue-statuses/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_issue_status_request import PatchedIssueStatusRequest # (1)
from waldur_api_client.api.support_issue_statuses import support_issue_statuses_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedIssueStatusRequest()
response = support_issue_statuses_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedIssueStatusRequest
  2. API Source: support_issue_statuses_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { supportIssueStatusesPartialUpdate } from 'waldur-js-client';

try {
  const response = await supportIssueStatusesPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
name string Status name in Jira.
type any

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string Status name in Jira.
type any
type_display string

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/support-issue-statuses/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.support_issue_statuses import support_issue_statuses_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = support_issue_statuses_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: support_issue_statuses_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { supportIssueStatusesDestroy } from 'waldur-js-client';

try {
  const response = await supportIssueStatusesDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Support Issues

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/support-issues/ List Support Issues
GET /api/support-issues/{uuid}/ Retrieve
POST /api/support-issues/ Create
PUT /api/support-issues/{uuid}/ Update
PATCH /api/support-issues/{uuid}/ Partial Update
DELETE /api/support-issues/{uuid}/ Delete
Other Actions
POST /api/support-issues/{uuid}/comment/ Comment
POST /api/support-issues/{uuid}/sync/ Sync

Core CRUD

List Support Issues

1
2
3
4
http \
  GET \
  https://api.example.com/api/support-issues/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.issue_o_enum import IssueOEnum # (1)
from waldur_api_client.api.support_issues import support_issues_list # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = support_issues_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: IssueOEnum
  2. API Source: support_issues_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { supportIssuesList } from 'waldur-js-client';

try {
  const response = await supportIssuesList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
assignee string (uri)
assignee_name string
caller string (uri)
caller_full_name string Caller full name contains
customer string (uri)
customer_uuid string (uuid)
key string
o array Ordering
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
project string (uri)
project_uuid string (uuid)
query string Summary or key contains
remote_id string
reporter string (uri)
reporter_name string
resolution_year_month string
resource string (uri) Filter by resource URL.
resource_external_ip string Resource external IP
resource_internal_ip string Resource internal IP
resource_uuid string (uuid) Resource UUID
status string
summary string
type string

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
type string
key string
backend_id string
backend_name string
remote_id string
link string (uri) Link to issue in support system.
summary string
description string
status string
resolution string
priority string
caller string (uri)
caller_uuid string (uuid)
caller_full_name string
reporter string (uri)
reporter_uuid string (uuid)
reporter_name string
assignee string (uri)
assignee_uuid string (uuid)
assignee_name string
customer string (uri)
customer_uuid string (uuid)
customer_name string
project string (uri)
project_uuid string (uuid)
project_name string
resource string
resource_type string
resource_name string
created string (date-time)
modified string (date-time)
template string (uri)
feedback any
resolved boolean
update_is_available boolean
destroy_is_available boolean
add_comment_is_available boolean
add_attachment_is_available boolean
processing_log any Internal processing log for debugging order lifecycle events. Visible only to staff.
order_uuid string Return order UUID if the issue's resource is an Order.
order_project_uuid string Return order's project UUID if the issue's resource is an Order.
order_customer_uuid string Return order's customer UUID if the issue's resource is an Order.
order_resource_name string Return order's resource name if the issue's resource is an Order.

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/support-issues/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.support_issues import support_issues_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = support_issues_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: support_issues_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { supportIssuesRetrieve } from 'waldur-js-client';

try {
  const response = await supportIssuesRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
url string (uri)
uuid string (uuid)
type string
key string
backend_id string
backend_name string
remote_id string
link string (uri) Link to issue in support system.
summary string
description string
status string
resolution string
priority string
caller string (uri)
caller_uuid string (uuid)
caller_full_name string
reporter string (uri)
reporter_uuid string (uuid)
reporter_name string
assignee string (uri)
assignee_uuid string (uuid)
assignee_name string
customer string (uri)
customer_uuid string (uuid)
customer_name string
project string (uri)
project_uuid string (uuid)
project_name string
resource string
resource_type string
resource_name string
created string (date-time)
modified string (date-time)
template string (uri)
feedback any
resolved boolean
update_is_available boolean
destroy_is_available boolean
add_comment_is_available boolean
add_attachment_is_available boolean
processing_log any Internal processing log for debugging order lifecycle events. Visible only to staff.
order_uuid string Return order UUID if the issue's resource is an Order.
order_project_uuid string Return order's project UUID if the issue's resource is an Order.
order_customer_uuid string Return order's customer UUID if the issue's resource is an Order.
order_resource_name string Return order's resource name if the issue's resource is an Order.

Create

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/support-issues/ \
  Authorization:"Token YOUR_API_TOKEN" \
  type="string-value" \
  summary="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.issue_request import IssueRequest # (1)
from waldur_api_client.api.support_issues import support_issues_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = IssueRequest(
    type="string-value",
    summary="string-value"
)
response = support_issues_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: IssueRequest
  2. API Source: support_issues_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { supportIssuesCreate } from 'waldur-js-client';

try {
  const response = await supportIssuesCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "type": "string-value",
    "summary": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
type string ✓
remote_id string
summary string ✓
description string
priority string
caller string (uri)
assignee string (uri)
customer string (uri)
project string (uri)
resource string
is_reported_manually boolean Set true if issue is created by regular user via portal.
Constraints: write-only, default: False
template string (uri)

201 -

Field Type Description
url string (uri)
uuid string (uuid)
type string
key string
backend_id string
backend_name string
remote_id string
link string (uri) Link to issue in support system.
summary string
description string
status string
resolution string
priority string
caller string (uri)
caller_uuid string (uuid)
caller_full_name string
reporter string (uri)
reporter_uuid string (uuid)
reporter_name string
assignee string (uri)
assignee_uuid string (uuid)
assignee_name string
customer string (uri)
customer_uuid string (uuid)
customer_name string
project string (uri)
project_uuid string (uuid)
project_name string
resource string
resource_type string
resource_name string
created string (date-time)
modified string (date-time)
template string (uri)
feedback any
resolved boolean
update_is_available boolean
destroy_is_available boolean
add_comment_is_available boolean
add_attachment_is_available boolean
processing_log any Internal processing log for debugging order lifecycle events. Visible only to staff.
order_uuid string Return order UUID if the issue's resource is an Order.
order_project_uuid string Return order's project UUID if the issue's resource is an Order.
order_customer_uuid string Return order's customer UUID if the issue's resource is an Order.
order_resource_name string Return order's resource name if the issue's resource is an Order.

Update

1
2
3
4
5
6
http \
  PUT \
  https://api.example.com/api/support-issues/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  type="string-value" \
  summary="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.issue_request import IssueRequest # (1)
from waldur_api_client.api.support_issues import support_issues_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = IssueRequest(
    type="string-value",
    summary="string-value"
)
response = support_issues_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: IssueRequest
  2. API Source: support_issues_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { supportIssuesUpdate } from 'waldur-js-client';

try {
  const response = await supportIssuesUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "type": "string-value",
    "summary": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
type string ✓
remote_id string
summary string ✓
description string
priority string
caller string (uri)
assignee string (uri)
customer string (uri)
project string (uri)
resource string
is_reported_manually boolean Set true if issue is created by regular user via portal.
Constraints: write-only, default: False
template string (uri)

200 -

Field Type Description
url string (uri)
uuid string (uuid)
type string
key string
backend_id string
backend_name string
remote_id string
link string (uri) Link to issue in support system.
summary string
description string
status string
resolution string
priority string
caller string (uri)
caller_uuid string (uuid)
caller_full_name string
reporter string (uri)
reporter_uuid string (uuid)
reporter_name string
assignee string (uri)
assignee_uuid string (uuid)
assignee_name string
customer string (uri)
customer_uuid string (uuid)
customer_name string
project string (uri)
project_uuid string (uuid)
project_name string
resource string
resource_type string
resource_name string
created string (date-time)
modified string (date-time)
template string (uri)
feedback any
resolved boolean
update_is_available boolean
destroy_is_available boolean
add_comment_is_available boolean
add_attachment_is_available boolean
processing_log any Internal processing log for debugging order lifecycle events. Visible only to staff.
order_uuid string Return order UUID if the issue's resource is an Order.
order_project_uuid string Return order's project UUID if the issue's resource is an Order.
order_customer_uuid string Return order's customer UUID if the issue's resource is an Order.
order_resource_name string Return order's resource name if the issue's resource is an Order.

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/support-issues/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_issue_request import PatchedIssueRequest # (1)
from waldur_api_client.api.support_issues import support_issues_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedIssueRequest()
response = support_issues_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedIssueRequest
  2. API Source: support_issues_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { supportIssuesPartialUpdate } from 'waldur-js-client';

try {
  const response = await supportIssuesPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
summary string
description string
assignee string (uri)
is_reported_manually boolean Set true if issue is created by regular user via portal.
Constraints: write-only, default: False

200 -

Field Type Description
url string (uri)
uuid string (uuid)
type string
key string
backend_id string
backend_name string
remote_id string
link string (uri) Link to issue in support system.
summary string
description string
status string
resolution string
priority string
caller string (uri)
caller_uuid string (uuid)
caller_full_name string
reporter string (uri)
reporter_uuid string (uuid)
reporter_name string
assignee string (uri)
assignee_uuid string (uuid)
assignee_name string
customer string (uri)
customer_uuid string (uuid)
customer_name string
project string (uri)
project_uuid string (uuid)
project_name string
resource string
resource_type string
resource_name string
created string (date-time)
modified string (date-time)
template string (uri)
feedback any
resolved boolean
update_is_available boolean
destroy_is_available boolean
add_comment_is_available boolean
add_attachment_is_available boolean
processing_log any Internal processing log for debugging order lifecycle events. Visible only to staff.
order_uuid string Return order UUID if the issue's resource is an Order.
order_project_uuid string Return order's project UUID if the issue's resource is an Order.
order_customer_uuid string Return order's customer UUID if the issue's resource is an Order.
order_resource_name string Return order's resource name if the issue's resource is an Order.

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/support-issues/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.support_issues import support_issues_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = support_issues_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: support_issues_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { supportIssuesDestroy } from 'waldur-js-client';

try {
  const response = await supportIssuesDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Other Actions

Comment

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/support-issues/a1b2c3d4-e5f6-7890-abcd-ef1234567890/comment/ \
  Authorization:"Token YOUR_API_TOKEN" \
  description="A sample description."

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.comment_request import CommentRequest # (1)
from waldur_api_client.api.support_issues import support_issues_comment # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = CommentRequest(
    description="A sample description."
)
response = support_issues_comment.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: CommentRequest
  2. API Source: support_issues_comment
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { supportIssuesComment } from 'waldur-js-client';

try {
  const response = await supportIssuesComment({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "description": "A sample description."
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
description string ✓
is_public boolean

200 -

Field Type
url string (uri)
uuid string (uuid)
issue string (uri)
issue_key string
description string
is_public boolean
author_name string
author_uuid string (uuid)
author_user string (uri)
author_email string (email)
backend_id string
remote_id string
created string (date-time)
update_is_available boolean
destroy_is_available boolean

Sync

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/support-issues/a1b2c3d4-e5f6-7890-abcd-ef1234567890/sync/ \
  Authorization:"Token YOUR_API_TOKEN" \
  type="string-value" \
  summary="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.issue_request import IssueRequest # (1)
from waldur_api_client.api.support_issues import support_issues_sync # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = IssueRequest(
    type="string-value",
    summary="string-value"
)
response = support_issues_sync.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: IssueRequest
  2. API Source: support_issues_sync
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { supportIssuesSync } from 'waldur-js-client';

try {
  const response = await supportIssuesSync({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "type": "string-value",
    "summary": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
type string ✓
remote_id string
summary string ✓
description string
priority string
caller string (uri)
assignee string (uri)
customer string (uri)
project string (uri)
resource string
is_reported_manually boolean Set true if issue is created by regular user via portal.
Constraints: write-only, default: False
template string (uri)

200 -

Field Type Description
url string (uri)
uuid string (uuid)
type string
key string
backend_id string
backend_name string
remote_id string
link string (uri) Link to issue in support system.
summary string
description string
status string
resolution string
priority string
caller string (uri)
caller_uuid string (uuid)
caller_full_name string
reporter string (uri)
reporter_uuid string (uuid)
reporter_name string
assignee string (uri)
assignee_uuid string (uuid)
assignee_name string
customer string (uri)
customer_uuid string (uuid)
customer_name string
project string (uri)
project_uuid string (uuid)
project_name string
resource string
resource_type string
resource_name string
created string (date-time)
modified string (date-time)
template string (uri)
feedback any
resolved boolean
update_is_available boolean
destroy_is_available boolean
add_comment_is_available boolean
add_attachment_is_available boolean
processing_log any Internal processing log for debugging order lifecycle events. Visible only to staff.
order_uuid string Return order UUID if the issue's resource is an Order.
order_project_uuid string Return order's project UUID if the issue's resource is an Order.
order_customer_uuid string Return order's customer UUID if the issue's resource is an Order.
order_resource_name string Return order's resource name if the issue's resource is an Order.

Support Priorities

Operations Summary

Method Endpoint Description
GET /api/support-priorities/ List Support Priorities
GET /api/support-priorities/{uuid}/ Retrieve

List Support Priorities

1
2
3
4
http \
  GET \
  https://api.example.com/api/support-priorities/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.support_priorities import support_priorities_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = support_priorities_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: support_priorities_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { supportPrioritiesList } from 'waldur-js-client';

try {
  const response = await supportPrioritiesList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
name string Name
name_exact string Name (exact)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
url string (uri)
uuid string (uuid)
name string
description string
icon_url string (uri)

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/support-priorities/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.support_priorities import support_priorities_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = support_priorities_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: support_priorities_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { supportPrioritiesRetrieve } from 'waldur-js-client';

try {
  const response = await supportPrioritiesRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
url string (uri)
uuid string (uuid)
name string
description string
icon_url string (uri)

Support Request Types Admin

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/support-request-types-admin/ List Support Request Types Admin
GET /api/support-request-types-admin/{uuid}/ Retrieve
POST /api/support-request-types-admin/ Create
PUT /api/support-request-types-admin/{uuid}/ Update
PATCH /api/support-request-types-admin/{uuid}/ Partial Update
DELETE /api/support-request-types-admin/{uuid}/ Delete
Other Actions
POST /api/support-request-types-admin/{uuid}/activate/ Activate a request type so it appears in issue creation
POST /api/support-request-types-admin/{uuid}/deactivate/ Deactivate a request type so it no longer appears in issue creation
POST /api/support-request-types-admin/reorder/ Bulk update order for multiple request types

Core CRUD

List Support Request Types Admin

1
2
3
4
http \
  GET \
  https://api.example.com/api/support-request-types-admin/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.support_request_types_admin import support_request_types_admin_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = support_request_types_admin_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: support_request_types_admin_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { supportRequestTypesAdminList } from 'waldur-js-client';

try {
  const response = await supportRequestTypesAdminList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
is_active boolean
name string
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
name string
issue_type_name string
backend_id integer Backend ID for synced types. Null for manually created types.
backend_name string
is_active boolean Whether this request type is available for issue creation.
order integer Display order. First type (lowest order) is the default.
is_synced boolean Returns True if the request type was synced from a backend.

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/support-request-types-admin/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.support_request_types_admin import support_request_types_admin_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = support_request_types_admin_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: support_request_types_admin_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { supportRequestTypesAdminRetrieve } from 'waldur-js-client';

try {
  const response = await supportRequestTypesAdminRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
issue_type_name string
backend_id integer Backend ID for synced types. Null for manually created types.
backend_name string
is_active boolean Whether this request type is available for issue creation.
order integer Display order. First type (lowest order) is the default.
is_synced boolean Returns True if the request type was synced from a backend.

Create

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/support-request-types-admin/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-support-request-types-admin" \
  issue_type_name="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.request_type_admin_request import RequestTypeAdminRequest # (1)
from waldur_api_client.api.support_request_types_admin import support_request_types_admin_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = RequestTypeAdminRequest(
    name="my-awesome-support-request-types-admin",
    issue_type_name="string-value"
)
response = support_request_types_admin_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: RequestTypeAdminRequest
  2. API Source: support_request_types_admin_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { supportRequestTypesAdminCreate } from 'waldur-js-client';

try {
  const response = await supportRequestTypesAdminCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "name": "my-awesome-support-request-types-admin",
    "issue_type_name": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
name string ✓
issue_type_name string ✓
is_active boolean Whether this request type is available for issue creation.
order integer Display order. First type (lowest order) is the default.

201 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
issue_type_name string
backend_id integer Backend ID for synced types. Null for manually created types.
backend_name string
is_active boolean Whether this request type is available for issue creation.
order integer Display order. First type (lowest order) is the default.
is_synced boolean Returns True if the request type was synced from a backend.

Update

1
2
3
4
5
6
http \
  PUT \
  https://api.example.com/api/support-request-types-admin/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-support-request-types-admin" \
  issue_type_name="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.request_type_admin_request import RequestTypeAdminRequest # (1)
from waldur_api_client.api.support_request_types_admin import support_request_types_admin_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = RequestTypeAdminRequest(
    name="my-awesome-support-request-types-admin",
    issue_type_name="string-value"
)
response = support_request_types_admin_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: RequestTypeAdminRequest
  2. API Source: support_request_types_admin_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { supportRequestTypesAdminUpdate } from 'waldur-js-client';

try {
  const response = await supportRequestTypesAdminUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-support-request-types-admin",
    "issue_type_name": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
name string ✓
issue_type_name string ✓
is_active boolean Whether this request type is available for issue creation.
order integer Display order. First type (lowest order) is the default.

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
issue_type_name string
backend_id integer Backend ID for synced types. Null for manually created types.
backend_name string
is_active boolean Whether this request type is available for issue creation.
order integer Display order. First type (lowest order) is the default.
is_synced boolean Returns True if the request type was synced from a backend.

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/support-request-types-admin/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_request_type_admin_request import PatchedRequestTypeAdminRequest # (1)
from waldur_api_client.api.support_request_types_admin import support_request_types_admin_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedRequestTypeAdminRequest()
response = support_request_types_admin_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedRequestTypeAdminRequest
  2. API Source: support_request_types_admin_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { supportRequestTypesAdminPartialUpdate } from 'waldur-js-client';

try {
  const response = await supportRequestTypesAdminPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
name string
issue_type_name string
is_active boolean Whether this request type is available for issue creation.
order integer Display order. First type (lowest order) is the default.

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
issue_type_name string
backend_id integer Backend ID for synced types. Null for manually created types.
backend_name string
is_active boolean Whether this request type is available for issue creation.
order integer Display order. First type (lowest order) is the default.
is_synced boolean Returns True if the request type was synced from a backend.

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/support-request-types-admin/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.support_request_types_admin import support_request_types_admin_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = support_request_types_admin_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: support_request_types_admin_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { supportRequestTypesAdminDestroy } from 'waldur-js-client';

try {
  const response = await supportRequestTypesAdminDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Other Actions

Activate a request type so it appears in issue creation

Activate a request type so it appears in issue creation.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/support-request-types-admin/a1b2c3d4-e5f6-7890-abcd-ef1234567890/activate/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-support-request-types-admin" \
  issue_type_name="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.request_type_admin_request import RequestTypeAdminRequest # (1)
from waldur_api_client.api.support_request_types_admin import support_request_types_admin_activate # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = RequestTypeAdminRequest(
    name="my-awesome-support-request-types-admin",
    issue_type_name="string-value"
)
response = support_request_types_admin_activate.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: RequestTypeAdminRequest
  2. API Source: support_request_types_admin_activate
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { supportRequestTypesAdminActivate } from 'waldur-js-client';

try {
  const response = await supportRequestTypesAdminActivate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-support-request-types-admin",
    "issue_type_name": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
name string ✓
issue_type_name string ✓
is_active boolean Whether this request type is available for issue creation.
order integer Display order. First type (lowest order) is the default.

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
issue_type_name string
backend_id integer Backend ID for synced types. Null for manually created types.
backend_name string
is_active boolean Whether this request type is available for issue creation.
order integer Display order. First type (lowest order) is the default.
is_synced boolean Returns True if the request type was synced from a backend.

Deactivate a request type so it no longer appears in issue creation

Deactivate a request type so it no longer appears in issue creation.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/support-request-types-admin/a1b2c3d4-e5f6-7890-abcd-ef1234567890/deactivate/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-support-request-types-admin" \
  issue_type_name="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.request_type_admin_request import RequestTypeAdminRequest # (1)
from waldur_api_client.api.support_request_types_admin import support_request_types_admin_deactivate # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = RequestTypeAdminRequest(
    name="my-awesome-support-request-types-admin",
    issue_type_name="string-value"
)
response = support_request_types_admin_deactivate.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: RequestTypeAdminRequest
  2. API Source: support_request_types_admin_deactivate
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { supportRequestTypesAdminDeactivate } from 'waldur-js-client';

try {
  const response = await supportRequestTypesAdminDeactivate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-support-request-types-admin",
    "issue_type_name": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
name string ✓
issue_type_name string ✓
is_active boolean Whether this request type is available for issue creation.
order integer Display order. First type (lowest order) is the default.

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
issue_type_name string
backend_id integer Backend ID for synced types. Null for manually created types.
backend_name string
is_active boolean Whether this request type is available for issue creation.
order integer Display order. First type (lowest order) is the default.
is_synced boolean Returns True if the request type was synced from a backend.

Bulk update order for multiple request types

Bulk update order for multiple request types.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/support-request-types-admin/reorder/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-support-request-types-admin-reorder" \
  issue_type_name="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.request_type_admin_request import RequestTypeAdminRequest # (1)
from waldur_api_client.api.support_request_types_admin import support_request_types_admin_reorder # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = RequestTypeAdminRequest(
    name="my-awesome-support-request-types-admin-reorder",
    issue_type_name="string-value"
)
response = support_request_types_admin_reorder.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: RequestTypeAdminRequest
  2. API Source: support_request_types_admin_reorder
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { supportRequestTypesAdminReorder } from 'waldur-js-client';

try {
  const response = await supportRequestTypesAdminReorder({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "name": "my-awesome-support-request-types-admin-reorder",
    "issue_type_name": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
name string ✓
issue_type_name string ✓
is_active boolean Whether this request type is available for issue creation.
order integer Display order. First type (lowest order) is the default.

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
issue_type_name string
backend_id integer Backend ID for synced types. Null for manually created types.
backend_name string
is_active boolean Whether this request type is available for issue creation.
order integer Display order. First type (lowest order) is the default.
is_synced boolean Returns True if the request type was synced from a backend.

Support Request Types

Operations Summary

Method Endpoint Description
GET /api/support-request-types/ List Support Request Types
GET /api/support-request-types/{uuid}/ Retrieve

List Support Request Types

1
2
3
4
http \
  GET \
  https://api.example.com/api/support-request-types/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.support_request_types import support_request_types_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = support_request_types_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: support_request_types_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { supportRequestTypesList } from 'waldur-js-client';

try {
  const response = await supportRequestTypesList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
name string
issue_type_name string
order integer Display order. First type (lowest order) is the default.

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/support-request-types/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.support_request_types import support_request_types_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = support_request_types_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: support_request_types_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { supportRequestTypesRetrieve } from 'waldur-js-client';

try {
  const response = await supportRequestTypesRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
issue_type_name string
order integer Display order. First type (lowest order) is the default.

Support

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/support/settings/atlassian/ List Support Settings Atlassian
GET /api/support/settings/atlassian/{id}/ Retrieve
POST /api/support/settings/atlassian/ Create
PUT /api/support/settings/atlassian/{id}/ Update
PATCH /api/support/settings/atlassian/{id}/ Partial Update
DELETE /api/support/settings/atlassian/{id}/ Delete
Other Actions
GET /api/support/settings/atlassian/current_settings/ Get current Atlassian settings (masked secrets)
POST /api/support/settings/atlassian/discover_custom_fields/ Discover available custom fields
POST /api/support/settings/atlassian/discover_priorities/ Discover available priorities
POST /api/support/settings/atlassian/discover_projects/ Discover available Service Desk projects
POST /api/support/settings/atlassian/discover_request_types/ Discover request types for a selected project
POST /api/support/settings/atlassian/preview_settings/ Generate preview of settings to be saved
POST /api/support/settings/atlassian/save_settings/ Save selected settings to constance
POST /api/support/settings/atlassian/validate_credentials/ Validate Atlassian credentials without saving them

Core CRUD

List Support Settings Atlassian

1
2
3
4
http \
  GET \
  https://api.example.com/api/support/settings/atlassian/ \
  Authorization:"Token YOUR_API_TOKEN"

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.support import support_settings_atlassian_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = support_settings_atlassian_list.sync(client=client)

print(response)
  1. API Source: support_settings_atlassian_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { supportSettingsAtlassianList } from 'waldur-js-client';

try {
  const response = await supportSettingsAtlassianList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 - No response body

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/support/settings/atlassian/123/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.support import support_settings_atlassian_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = support_settings_atlassian_retrieve.sync(
    id=123,
    client=client
)

print(response)
  1. API Source: support_settings_atlassian_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { supportSettingsAtlassianRetrieve } from 'waldur-js-client';

try {
  const response = await supportSettingsAtlassianRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "id": 123
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
id integer ✓ A unique integer value identifying this issue.

200 - No response body

Create

1
2
3
4
http \
  POST \
  https://api.example.com/api/support/settings/atlassian/ \
  Authorization:"Token YOUR_API_TOKEN"

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.support import support_settings_atlassian_create # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = support_settings_atlassian_create.sync(client=client)

print(response)
  1. API Source: support_settings_atlassian_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { supportSettingsAtlassianCreate } from 'waldur-js-client';

try {
  const response = await supportSettingsAtlassianCreate({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

201 - No response body

Update

1
2
3
4
http \
  PUT \
  https://api.example.com/api/support/settings/atlassian/123/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.support import support_settings_atlassian_update # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = support_settings_atlassian_update.sync(
    id=123,
    client=client
)

print(response)
  1. API Source: support_settings_atlassian_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { supportSettingsAtlassianUpdate } from 'waldur-js-client';

try {
  const response = await supportSettingsAtlassianUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "id": 123
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
id integer ✓ A unique integer value identifying this issue.

200 - No response body

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/support/settings/atlassian/123/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.support import support_settings_atlassian_partial_update # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = support_settings_atlassian_partial_update.sync(
    id=123,
    client=client
)

print(response)
  1. API Source: support_settings_atlassian_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { supportSettingsAtlassianPartialUpdate } from 'waldur-js-client';

try {
  const response = await supportSettingsAtlassianPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "id": 123
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
id integer ✓ A unique integer value identifying this issue.

200 - No response body

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/support/settings/atlassian/123/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.support import support_settings_atlassian_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = support_settings_atlassian_destroy.sync(
    id=123,
    client=client
)

print(response)
  1. API Source: support_settings_atlassian_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { supportSettingsAtlassianDestroy } from 'waldur-js-client';

try {
  const response = await supportSettingsAtlassianDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "id": 123
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
id integer ✓ A unique integer value identifying this issue.

204 - No response body

Other Actions

Get current Atlassian settings (masked secrets)

Get current Atlassian settings (masked secrets).

1
2
3
4
http \
  GET \
  https://api.example.com/api/support/settings/atlassian/current_settings/ \
  Authorization:"Token YOUR_API_TOKEN"

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.support import support_settings_atlassian_current_settings_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = support_settings_atlassian_current_settings_retrieve.sync(client=client)

print(response)
  1. API Source: support_settings_atlassian_current_settings_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { supportSettingsAtlassianCurrentSettingsRetrieve } from 'waldur-js-client';

try {
  const response = await supportSettingsAtlassianCurrentSettingsRetrieve({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

200 - No response body

Discover available custom fields

Discover available custom fields.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/support/settings/atlassian/discover_custom_fields/ \
  Authorization:"Token YOUR_API_TOKEN" \
  api_url="https://api.example.com/api/api-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  auth_method=null

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.discover_custom_fields_request_request import DiscoverCustomFieldsRequestRequest # (1)
from waldur_api_client.api.support import support_settings_atlassian_discover_custom_fields # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = DiscoverCustomFieldsRequestRequest(
    api_url="https://api.example.com/api/api-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    auth_method=null
)
response = support_settings_atlassian_discover_custom_fields.sync(
    client=client,
    body=body_data
)

for item in response:
    print(item)
  1. Model Source: DiscoverCustomFieldsRequestRequest
  2. API Source: support_settings_atlassian_discover_custom_fields
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { supportSettingsAtlassianDiscoverCustomFields } from 'waldur-js-client';

try {
  const response = await supportSettingsAtlassianDiscoverCustomFields({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "api_url": "https://api.example.com/api/api-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "auth_method": null
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
Field Type Required Description
api_url string (uri) ✓ Atlassian API URL (e.g., https://your-domain.atlassian.net)
auth_method any ✓ Authentication method to use
email string (email)
token string
Constraints: write-only
personal_access_token string
Constraints: write-only
username string
password string
Constraints: write-only
verify_ssl boolean
Constraints: default: True
project_id string
request_type_id string Optional: Filter fields by request type

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
id string
name string
clause_names array of strings
field_type string
required boolean

Discover available priorities

Discover available priorities.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/support/settings/atlassian/discover_priorities/ \
  Authorization:"Token YOUR_API_TOKEN" \
  api_url="https://api.example.com/api/api-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  auth_method=null

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.discover_priorities_request_request import DiscoverPrioritiesRequestRequest # (1)
from waldur_api_client.api.support import support_settings_atlassian_discover_priorities # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = DiscoverPrioritiesRequestRequest(
    api_url="https://api.example.com/api/api-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    auth_method=null
)
response = support_settings_atlassian_discover_priorities.sync(
    client=client,
    body=body_data
)

for item in response:
    print(item)
  1. Model Source: DiscoverPrioritiesRequestRequest
  2. API Source: support_settings_atlassian_discover_priorities
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { supportSettingsAtlassianDiscoverPriorities } from 'waldur-js-client';

try {
  const response = await supportSettingsAtlassianDiscoverPriorities({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "api_url": "https://api.example.com/api/api-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "auth_method": null
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
Field Type Required Description
api_url string (uri) ✓ Atlassian API URL (e.g., https://your-domain.atlassian.net)
auth_method any ✓ Authentication method to use
email string (email)
token string
Constraints: write-only
personal_access_token string
Constraints: write-only
username string
password string
Constraints: write-only
verify_ssl boolean
Constraints: default: True

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
id string
name string
description string
icon_url string (uri)

Discover available Service Desk projects

Discover available Service Desk projects.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/support/settings/atlassian/discover_projects/ \
  Authorization:"Token YOUR_API_TOKEN" \
  api_url="https://api.example.com/api/api-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  auth_method=null

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.discover_projects_request_request import DiscoverProjectsRequestRequest # (1)
from waldur_api_client.api.support import support_settings_atlassian_discover_projects # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = DiscoverProjectsRequestRequest(
    api_url="https://api.example.com/api/api-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    auth_method=null
)
response = support_settings_atlassian_discover_projects.sync(
    client=client,
    body=body_data
)

for item in response:
    print(item)
  1. Model Source: DiscoverProjectsRequestRequest
  2. API Source: support_settings_atlassian_discover_projects
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { supportSettingsAtlassianDiscoverProjects } from 'waldur-js-client';

try {
  const response = await supportSettingsAtlassianDiscoverProjects({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "api_url": "https://api.example.com/api/api-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "auth_method": null
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
Field Type Required Description
api_url string (uri) ✓ Atlassian API URL (e.g., https://your-domain.atlassian.net)
auth_method any ✓ Authentication method to use
email string (email)
token string
Constraints: write-only
personal_access_token string
Constraints: write-only
username string
password string
Constraints: write-only
verify_ssl boolean
Constraints: default: True

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
id string
key string
name string
description string

Discover request types for a selected project

Discover request types for a selected project.

1
2
3
4
5
6
7
http \
  POST \
  https://api.example.com/api/support/settings/atlassian/discover_request_types/ \
  Authorization:"Token YOUR_API_TOKEN" \
  api_url="https://api.example.com/api/api-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  auth_method=null \
  project_id="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.discover_request_types_request_request import DiscoverRequestTypesRequestRequest # (1)
from waldur_api_client.api.support import support_settings_atlassian_discover_request_types # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = DiscoverRequestTypesRequestRequest(
    api_url="https://api.example.com/api/api-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    auth_method=null,
    project_id="string-value"
)
response = support_settings_atlassian_discover_request_types.sync(
    client=client,
    body=body_data
)

for item in response:
    print(item)
  1. Model Source: DiscoverRequestTypesRequestRequest
  2. API Source: support_settings_atlassian_discover_request_types
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
import { supportSettingsAtlassianDiscoverRequestTypes } from 'waldur-js-client';

try {
  const response = await supportSettingsAtlassianDiscoverRequestTypes({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "api_url": "https://api.example.com/api/api-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "auth_method": null,
    "project_id": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
Field Type Required Description
api_url string (uri) ✓ Atlassian API URL (e.g., https://your-domain.atlassian.net)
auth_method any ✓ Authentication method to use
email string (email)
token string
Constraints: write-only
personal_access_token string
Constraints: write-only
username string
password string
Constraints: write-only
verify_ssl boolean
Constraints: default: True
project_id string ✓ Service Desk project ID or key

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
id string
name string
description string
issue_type_id string

Generate preview of settings to be saved

Generate preview of settings to be saved.

1
2
3
4
5
6
7
http \
  POST \
  https://api.example.com/api/support/settings/atlassian/preview_settings/ \
  Authorization:"Token YOUR_API_TOKEN" \
  api_url="https://api.example.com/api/api-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  auth_method="api_token" \
  project_id="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.atlassian_settings_preview_request import AtlassianSettingsPreviewRequest # (1)
from waldur_api_client.api.support import support_settings_atlassian_preview_settings # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = AtlassianSettingsPreviewRequest(
    api_url="https://api.example.com/api/api-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    auth_method="api_token",
    project_id="string-value"
)
response = support_settings_atlassian_preview_settings.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: AtlassianSettingsPreviewRequest
  2. API Source: support_settings_atlassian_preview_settings
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
import { supportSettingsAtlassianPreviewSettings } from 'waldur-js-client';

try {
  const response = await supportSettingsAtlassianPreviewSettings({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "api_url": "https://api.example.com/api/api-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "auth_method": "api_token",
    "project_id": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
api_url string (uri) ✓
auth_method string ✓
Enum: api_token, personal_access_token, basic
email string (email)
token string
Constraints: write-only
personal_access_token string
Constraints: write-only
username string
password string
Constraints: write-only
verify_ssl boolean
Constraints: default: True
project_id string ✓
issue_types array of strings
support_type_mapping object (free-form) Mapping from frontend types to backend request types
reporter_field string
impact_field string
organisation_field string
project_field string
affected_resource_field string
caller_field string
template_field string
sla_field string
resolution_sla_field string
satisfaction_field string
request_feedback_field string
waldur_backend_id_field string
default_offering_issue_type string Default issue type for marketplace request-based orders
use_old_api boolean
Constraints: default: False
custom_field_mapping_enabled boolean
Constraints: default: True

200 - No response body

Save selected settings to constance

Save selected settings to constance.

1
2
3
4
5
6
7
8
http \
  POST \
  https://api.example.com/api/support/settings/atlassian/save_settings/ \
  Authorization:"Token YOUR_API_TOKEN" \
  api_url="https://api.example.com/api/api-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  auth_method="api_token" \
  project_id="string-value" \
  confirm_save=true

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.atlassian_settings_save_request import AtlassianSettingsSaveRequest # (1)
from waldur_api_client.api.support import support_settings_atlassian_save_settings # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = AtlassianSettingsSaveRequest(
    api_url="https://api.example.com/api/api-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    auth_method="api_token",
    project_id="string-value",
    confirm_save=true
)
response = support_settings_atlassian_save_settings.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: AtlassianSettingsSaveRequest
  2. API Source: support_settings_atlassian_save_settings
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { supportSettingsAtlassianSaveSettings } from 'waldur-js-client';

try {
  const response = await supportSettingsAtlassianSaveSettings({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "api_url": "https://api.example.com/api/api-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "auth_method": "api_token",
    "project_id": "string-value",
    "confirm_save": true
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
api_url string (uri) ✓
auth_method string ✓
Enum: api_token, personal_access_token, basic
email string (email)
token string
Constraints: write-only
personal_access_token string
Constraints: write-only
username string
password string
Constraints: write-only
verify_ssl boolean
Constraints: default: True
project_id string ✓
issue_types array of strings
support_type_mapping object (free-form) Mapping from frontend types to backend request types
reporter_field string
impact_field string
organisation_field string
project_field string
affected_resource_field string
caller_field string
template_field string
sla_field string
resolution_sla_field string
satisfaction_field string
request_feedback_field string
waldur_backend_id_field string
default_offering_issue_type string Default issue type for marketplace request-based orders
use_old_api boolean
Constraints: default: False
custom_field_mapping_enabled boolean
Constraints: default: True
confirm_save boolean ✓ Must be True to confirm saving settings

200 - No response body

Validate Atlassian credentials without saving them

Validate Atlassian credentials without saving them.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/support/settings/atlassian/validate_credentials/ \
  Authorization:"Token YOUR_API_TOKEN" \
  api_url="https://api.example.com/api/api-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  auth_method=null

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.atlassian_credentials_request import AtlassianCredentialsRequest # (1)
from waldur_api_client.api.support import support_settings_atlassian_validate_credentials # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = AtlassianCredentialsRequest(
    api_url="https://api.example.com/api/api-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    auth_method=null
)
response = support_settings_atlassian_validate_credentials.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: AtlassianCredentialsRequest
  2. API Source: support_settings_atlassian_validate_credentials
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { supportSettingsAtlassianValidateCredentials } from 'waldur-js-client';

try {
  const response = await supportSettingsAtlassianValidateCredentials({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "api_url": "https://api.example.com/api/api-url/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "auth_method": null
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
api_url string (uri) ✓ Atlassian API URL (e.g., https://your-domain.atlassian.net)
auth_method any ✓ Authentication method to use
email string (email)
token string
Constraints: write-only
personal_access_token string
Constraints: write-only
username string
password string
Constraints: write-only
verify_ssl boolean
Constraints: default: True

200 - No response body

Sync Issues

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/sync-issues/ This view triggers synchronization of issues from backend
Other Actions
POST /api/sync-issues/ This view triggers synchronization of issues from backend

Core CRUD

This view triggers synchronization of issues from backend

This view triggers synchronization of issues from backend.

1
2
3
4
http \
  GET \
  https://api.example.com/api/sync-issues/ \
  Authorization:"Token YOUR_API_TOKEN"

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.sync_issues import sync_issues_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = sync_issues_retrieve.sync(client=client)

print(response)
  1. API Source: sync_issues_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { syncIssuesRetrieve } from 'waldur-js-client';

try {
  const response = await syncIssuesRetrieve({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

202 - No response body

403 - No response body

Other Actions

This view triggers synchronization of issues from backend

This view triggers synchronization of issues from backend.

1
2
3
4
http \
  POST \
  https://api.example.com/api/sync-issues/ \
  Authorization:"Token YOUR_API_TOKEN"

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.sync_issues import sync_issues # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = sync_issues.sync(client=client)

print(response)
  1. API Source: sync_issues
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { syncIssues } from 'waldur-js-client';

try {
  const response = await syncIssues({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

202 - No response body

403 - No response body

Support Templates

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/support-templates/ List Support Templates
GET /api/support-templates/{uuid}/ Retrieve
POST /api/support-templates/ Create
POST /api/support-templates/{uuid}/create_attachments/ This view attaches documents to template
PUT /api/support-templates/{uuid}/ Update
PATCH /api/support-templates/{uuid}/ Partial Update
DELETE /api/support-templates/{uuid}/ Delete
Other Actions
POST /api/support-templates/{uuid}/delete_attachments/ Delete attachments

Core CRUD

List Support Templates

1
2
3
4
http \
  GET \
  https://api.example.com/api/support-templates/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.support_templates import support_templates_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = support_templates_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: support_templates_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { supportTemplatesList } from 'waldur-js-client';

try {
  const response = await supportTemplatesList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
url string (uri)
uuid string (uuid)
name string
description string
issue_type string
attachments array of objects
attachments.uuid string (uuid)
attachments.name string
attachments.file string (uri)
attachments.mime_type string
attachments.file_size integer
attachments.created string (date-time)

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/support-templates/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.support_templates import support_templates_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = support_templates_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: support_templates_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { supportTemplatesRetrieve } from 'waldur-js-client';

try {
  const response = await supportTemplatesRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
url string (uri)
uuid string (uuid)
name string
description string
issue_type string
attachments array of objects
attachments.uuid string (uuid)
attachments.name string
attachments.file string (uri)
attachments.mime_type string
attachments.file_size integer
attachments.created string (date-time)

Create

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/support-templates/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-support-template" \
  description="A sample description."

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.template_request import TemplateRequest # (1)
from waldur_api_client.api.support_templates import support_templates_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = TemplateRequest(
    name="my-awesome-support-template",
    description="A sample description."
)
response = support_templates_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: TemplateRequest
  2. API Source: support_templates_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { supportTemplatesCreate } from 'waldur-js-client';

try {
  const response = await supportTemplatesCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "name": "my-awesome-support-template",
    "description": "A sample description."
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required
name string ✓
description string ✓
issue_type string

201 -

Field Type
url string (uri)
uuid string (uuid)
name string
description string
issue_type string
attachments array of objects
attachments.uuid string (uuid)
attachments.name string
attachments.file string (uri)
attachments.mime_type string
attachments.file_size integer
attachments.created string (date-time)

This view attaches documents to template

This view attaches documents to template.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/support-templates/a1b2c3d4-e5f6-7890-abcd-ef1234567890/create_attachments/ \
  Authorization:"Token YOUR_API_TOKEN" \
  attachments:='[]'

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.create_attachments_request import CreateAttachmentsRequest # (1)
from waldur_api_client.api.support_templates import support_templates_create_attachments # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = CreateAttachmentsRequest(
    attachments=[]
)
response = support_templates_create_attachments.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: CreateAttachmentsRequest
  2. API Source: support_templates_create_attachments
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { supportTemplatesCreateAttachments } from 'waldur-js-client';

try {
  const response = await supportTemplatesCreateAttachments({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "attachments": []
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
attachments array of string (binary)s ✓ List of files to attach

201 - No response body

400 - No response body

Update

1
2
3
4
5
6
http \
  PUT \
  https://api.example.com/api/support-templates/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-support-template" \
  description="A sample description."

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.template_request import TemplateRequest # (1)
from waldur_api_client.api.support_templates import support_templates_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = TemplateRequest(
    name="my-awesome-support-template",
    description="A sample description."
)
response = support_templates_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: TemplateRequest
  2. API Source: support_templates_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { supportTemplatesUpdate } from 'waldur-js-client';

try {
  const response = await supportTemplatesUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-support-template",
    "description": "A sample description."
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
name string ✓
description string ✓
issue_type string

200 -

Field Type
url string (uri)
uuid string (uuid)
name string
description string
issue_type string
attachments array of objects
attachments.uuid string (uuid)
attachments.name string
attachments.file string (uri)
attachments.mime_type string
attachments.file_size integer
attachments.created string (date-time)

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/support-templates/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_template_request import PatchedTemplateRequest # (1)
from waldur_api_client.api.support_templates import support_templates_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedTemplateRequest()
response = support_templates_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedTemplateRequest
  2. API Source: support_templates_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { supportTemplatesPartialUpdate } from 'waldur-js-client';

try {
  const response = await supportTemplatesPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
name string
description string
issue_type string

200 -

Field Type
url string (uri)
uuid string (uuid)
name string
description string
issue_type string
attachments array of objects
attachments.uuid string (uuid)
attachments.name string
attachments.file string (uri)
attachments.mime_type string
attachments.file_size integer
attachments.created string (date-time)

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/support-templates/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.support_templates import support_templates_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = support_templates_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: support_templates_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { supportTemplatesDestroy } from 'waldur-js-client';

try {
  const response = await supportTemplatesDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Other Actions

Delete attachments

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/support-templates/a1b2c3d4-e5f6-7890-abcd-ef1234567890/delete_attachments/ \
  Authorization:"Token YOUR_API_TOKEN" \
  attachment_ids:='[]'

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.delete_attachments_request import DeleteAttachmentsRequest # (1)
from waldur_api_client.api.support_templates import support_templates_delete_attachments # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = DeleteAttachmentsRequest(
    attachment_ids=[]
)
response = support_templates_delete_attachments.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: DeleteAttachmentsRequest
  2. API Source: support_templates_delete_attachments
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { supportTemplatesDeleteAttachments } from 'waldur-js-client';

try {
  const response = await supportTemplatesDeleteAttachments({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "attachment_ids": []
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
attachment_ids array of string (uuid)s ✓

200 - No response body

Support Users

Operations Summary

Method Endpoint Description
GET /api/support-users/ List Support Users
GET /api/support-users/{uuid}/ Retrieve

List Support Users

1
2
3
4
http \
  GET \
  https://api.example.com/api/support-users/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.support_users import support_users_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = support_users_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: support_users_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { supportUsersList } from 'waldur-js-client';

try {
  const response = await supportUsersList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
backend_id string
name string
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
user integer

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
url string (uri)
uuid string (uuid)
name string
backend_id string
user string (uri)
backend_name string

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/support-users/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.support_users import support_users_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = support_users_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: support_users_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { supportUsersRetrieve } from 'waldur-js-client';

try {
  const response = await supportUsersRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
url string (uri)
uuid string (uuid)
name string
backend_id string
user string (uri)
backend_name string

Webhooks

Support Jira Webhook

Operations Summary

Method Endpoint Description
POST /api/support-jira-webhook/ Webhook

Webhook

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/support-jira-webhook/ \
  Authorization:"Token YOUR_API_TOKEN" \
  webhookEvent="string-value" \
  issue:='{}'

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.web_hook_receiver_request import WebHookReceiverRequest # (1)
from waldur_api_client.api.support_jira_webhook import support_jira_webhook # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = WebHookReceiverRequest(
    webhookEvent="string-value",
    issue={}
)
response = support_jira_webhook.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: WebHookReceiverRequest
  2. API Source: support_jira_webhook
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { supportJiraWebhook } from 'waldur-js-client';

try {
  const response = await supportJiraWebhook({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "webhookEvent": "string-value",
    "issue": {}
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
webhookEvent string ✓
issue object ✓
issue.key string ✓ Jira issue key
issue.fields object ✓
issue.fields.project object ✓
issue.fields.project.id string ✓ Jira field ID
issue.fields.project.name string ✓ Jira field name
issue.fields.project.key string ✓ Jira project key
issue.fields.comment object (free-form)
comment object
comment.id string ✓ Jira comment ID
changelog object
changelog.items array of anys ✓ List of changelog items
issue_event_type_name string

200 -

Field Type Description
webhookEvent string
issue object
issue.key string Jira issue key
issue.fields object
issue.fields.project object
issue.fields.project.id string Jira field ID
issue.fields.project.name string Jira field name
issue.fields.project.key string Jira project key
issue.fields.comment object (free-form)
comment object
comment.id string Jira comment ID
changelog object
changelog.items array of anys List of changelog items
issue_event_type_name string

Support Smax Webhook

Operations Summary

Method Endpoint Description
POST /api/support-smax-webhook/ Webhook

Webhook

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/support-smax-webhook/ \
  Authorization:"Token YOUR_API_TOKEN" \
  id="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.smax_web_hook_receiver_request import SmaxWebHookReceiverRequest # (1)
from waldur_api_client.api.support_smax_webhook import support_smax_webhook # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = SmaxWebHookReceiverRequest(
    id="string-value"
)
response = support_smax_webhook.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: SmaxWebHookReceiverRequest
  2. API Source: support_smax_webhook
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { supportSmaxWebhook } from 'waldur-js-client';

try {
  const response = await supportSmaxWebhook({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "id": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required
id string ✓

200 -

Field Type
id string

Support Zammad Webhook

Operations Summary

Method Endpoint Description
POST /api/support-zammad-webhook/ Webhook

Webhook

1
2
3
4
http \
  POST \
  https://api.example.com/api/support-zammad-webhook/ \
  Authorization:"Token YOUR_API_TOKEN"

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.support_zammad_webhook import support_zammad_webhook # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = support_zammad_webhook.sync(client=client)

print(response)
  1. API Source: support_zammad_webhook
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { supportZammadWebhook } from 'waldur-js-client';

try {
  const response = await supportZammadWebhook({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

200 - No response body

Uncategorized

Identity bridge

Identity Bridge

Operations Summary

Method Endpoint Description
GET /api/identity-bridge/stats/ Get Identity Bridge statistics
POST /api/identity-bridge/ Push user attributes from an ISD
POST /api/identity-bridge/remove/ Remove a user from an ISD

Get Identity Bridge statistics

Returns system-wide statistics about the Identity Bridge: feature configuration, per-ISD user counts, stale attribute detection, and total federated user counts. Staff only.

1
2
3
4
http \
  GET \
  https://api.example.com/api/identity-bridge/stats/ \
  Authorization:"Token YOUR_API_TOKEN"

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.identity_bridge import identity_bridge_stats_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = identity_bridge_stats_retrieve.sync(client=client)

print(response)
  1. API Source: identity_bridge_stats_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { identityBridgeStatsRetrieve } from 'waldur-js-client';

try {
  const response = await identityBridgeStatsRetrieve({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

200 -

Field Type
enabled boolean
deactivation_policy string
allowed_attributes array of strings
total_federated_users integer
total_active_federated_users integer
users_per_isd array of objects
users_per_isd.isd string
users_per_isd.user_count integer
users_per_isd.stale_user_count integer
users_per_isd.oldest_sync string
stale_threshold_days integer
identity_managers array of objects
identity_managers.uuid string (uuid)
identity_managers.full_name string
identity_managers.managed_isds array of strings

Push user attributes from an ISD

Allows Identity Service Domains (ISDs) to push user attributes to Waldur. Creates or updates a user based on username (CUID). Requires FEDERATED_IDENTITY_SYNC_ENABLED to be True. Caller must be staff or an identity manager with the declared source in managed_isds.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/identity-bridge/ \
  Authorization:"Token YOUR_API_TOKEN" \
  username="alice" \
  source="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.identity_bridge_request_request import IdentityBridgeRequestRequest # (1)
from waldur_api_client.api.identity_bridge import identity_bridge # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = IdentityBridgeRequestRequest(
    username="alice",
    source="string-value"
)
response = identity_bridge.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: IdentityBridgeRequestRequest
  2. API Source: identity_bridge
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { identityBridge } from 'waldur-js-client';

try {
  const response = await identityBridge({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "username": "alice",
    "source": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
username string ✓ CUID / username of the user to create or update.
source string ✓ ISD source identifier, e.g. 'isd:puhuri'. Must match ^[a-z]+:[a-zA-Z0-9._-]+$.
first_name string
last_name string
email string (email)
organization string
affiliations array of strings
civil_number string
phone_number string
identity_source string
gender integer
personal_title string
birth_date string (date)
place_of_birth string
country_of_residence string
nationality string
nationalities array of strings
organization_country string
organization_type string
eduperson_assurance array of strings

200 -

Field Type
uuid string (uuid)
created boolean
updated_fields array of strings

Remove a user from an ISD

Signals that a user has been removed from an ISD. Removes the source from active_isds, clears attributes owned by that source, and deactivates the user if no ISDs remain (configurable via FEDERATED_IDENTITY_DEACTIVATION_POLICY). Requires FEDERATED_IDENTITY_SYNC_ENABLED to be True. Caller must be staff or an identity manager with the declared source in managed_isds.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/identity-bridge/remove/ \
  Authorization:"Token YOUR_API_TOKEN" \
  username="alice" \
  source="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.identity_bridge_remove_request import IdentityBridgeRemoveRequest # (1)
from waldur_api_client.api.identity_bridge import identity_bridge_remove # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = IdentityBridgeRemoveRequest(
    username="alice",
    source="string-value"
)
response = identity_bridge_remove.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: IdentityBridgeRemoveRequest
  2. API Source: identity_bridge_remove
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { identityBridgeRemove } from 'waldur-js-client';

try {
  const response = await identityBridgeRemove({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "username": "alice",
    "source": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
username string ✓ CUID / username of the user to remove from the ISD.
source string ✓ ISD source identifier, e.g. 'isd:puhuri'. Must match ^[a-z]+:[a-zA-Z0-9._-]+$.

200 -

Field Type
uuid string (uuid)
deactivated boolean

Offering keycloak groups

Offering Keycloak Groups

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/offering-keycloak-groups/ List Offering Keycloak Groups
GET /api/offering-keycloak-groups/{uuid}/ Retrieve
POST /api/offering-keycloak-groups/{uuid}/pull_members/ Pull members from Keycloak for a group
DELETE /api/offering-keycloak-groups/{uuid}/ Delete
Other Actions
GET /api/offering-keycloak-groups/remote_group_members/ List members of a remote Keycloak group
GET /api/offering-keycloak-groups/remote_groups/ List remote Keycloak groups for an offering
GET /api/offering-keycloak-groups/search_remote_users/ Search for users in remote Keycloak instance
GET /api/offering-keycloak-groups/sync_status/ Compare local and remote Keycloak group state
POST /api/offering-keycloak-groups/import_remote/ Import a remote Keycloak group as a local OfferingKeycloakGroup
POST /api/offering-keycloak-groups/{uuid}/set_backend_id/ Set or unlink the backend_id (remote Keycloak group ID) for a local group
POST /api/offering-keycloak-groups/test_connection/ Test Keycloak connection for an offering

Core CRUD

List Offering Keycloak Groups

1
2
3
4
http \
  GET \
  https://api.example.com/api/offering-keycloak-groups/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.offering_keycloak_groups import offering_keycloak_groups_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = offering_keycloak_groups_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: offering_keycloak_groups_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { offeringKeycloakGroupsList } from 'waldur-js-client';

try {
  const response = await offeringKeycloakGroupsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
offering_uuid string (uuid)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
resource_uuid string (uuid)
role_uuid string (uuid)

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid)
url string (uri)
name string
backend_id string
offering string (uri)
offering_uuid string (uuid)
offering_name string
role string (uri)
role_name string
role_scope_type string Level this role applies at, e.g. 'cluster', 'project'. Empty means offering-wide.
resource string (uri)
resource_uuid string (uuid)
resource_name string
scope_id string Sub-entity identifier within a resource, e.g. Rancher project ID within a cluster.
created string (date-time)
modified string (date-time)

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/offering-keycloak-groups/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.offering_keycloak_groups import offering_keycloak_groups_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = offering_keycloak_groups_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: offering_keycloak_groups_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { offeringKeycloakGroupsRetrieve } from 'waldur-js-client';

try {
  const response = await offeringKeycloakGroupsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
uuid string (uuid)
url string (uri)
name string
backend_id string
offering string (uri)
offering_uuid string (uuid)
offering_name string
role string (uri)
role_name string
role_scope_type string Level this role applies at, e.g. 'cluster', 'project'. Empty means offering-wide.
resource string (uri)
resource_uuid string (uuid)
resource_name string
scope_id string Sub-entity identifier within a resource, e.g. Rancher project ID within a cluster.
created string (date-time)
modified string (date-time)

Pull members from Keycloak for a group

1
2
3
4
http \
  POST \
  https://api.example.com/api/offering-keycloak-groups/a1b2c3d4-e5f6-7890-abcd-ef1234567890/pull_members/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.offering_keycloak_groups import offering_keycloak_groups_pull_members # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = offering_keycloak_groups_pull_members.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: offering_keycloak_groups_pull_members
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { offeringKeycloakGroupsPullMembers } from 'waldur-js-client';

try {
  const response = await offeringKeycloakGroupsPullMembers({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
created integer
updated integer
total_remote integer

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/offering-keycloak-groups/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.offering_keycloak_groups import offering_keycloak_groups_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = offering_keycloak_groups_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: offering_keycloak_groups_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { offeringKeycloakGroupsDestroy } from 'waldur-js-client';

try {
  const response = await offeringKeycloakGroupsDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Other Actions

List members of a remote Keycloak group

1
2
3
4
5
6
http \
  GET \
  https://api.example.com/api/offering-keycloak-groups/remote_group_members/ \
  Authorization:"Token YOUR_API_TOKEN" \
  group_id=="string-value" \
  offering_uuid=="a1b2c3d4-e5f6-7890-abcd-ef1234567890"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.offering_keycloak_groups import offering_keycloak_groups_remote_group_members_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = offering_keycloak_groups_remote_group_members_list.sync(
    client=client,
    group_id="string-value",
    offering_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
)

for item in response:
    print(item)
  1. API Source: offering_keycloak_groups_remote_group_members_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { offeringKeycloakGroupsRemoteGroupMembersList } from 'waldur-js-client';

try {
  const response = await offeringKeycloakGroupsRemoteGroupMembersList({
  auth: "Token YOUR_API_TOKEN",
  query: {
    "group_id": "string-value",
    "offering_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
group_id string ✓ Keycloak group ID
offering_uuid string ✓ UUID of the offering
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
resource_uuid string (uuid)
role_uuid string (uuid)

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
id string
username string
email string
first_name string
last_name string

List remote Keycloak groups for an offering

1
2
3
4
5
http \
  GET \
  https://api.example.com/api/offering-keycloak-groups/remote_groups/ \
  Authorization:"Token YOUR_API_TOKEN" \
  offering_uuid=="a1b2c3d4-e5f6-7890-abcd-ef1234567890"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.offering_keycloak_groups import offering_keycloak_groups_remote_groups_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = offering_keycloak_groups_remote_groups_list.sync(
    client=client,
    offering_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
)

for item in response:
    print(item)
  1. API Source: offering_keycloak_groups_remote_groups_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { offeringKeycloakGroupsRemoteGroupsList } from 'waldur-js-client';

try {
  const response = await offeringKeycloakGroupsRemoteGroupsList({
  auth: "Token YOUR_API_TOKEN",
  query: {
    "offering_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
offering_uuid string ✓ UUID of the offering
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
resource_uuid string (uuid)
role_uuid string (uuid)

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
id string
name string
path string
sub_group_count integer

Search for users in remote Keycloak instance

1
2
3
4
5
6
http \
  GET \
  https://api.example.com/api/offering-keycloak-groups/search_remote_users/ \
  Authorization:"Token YOUR_API_TOKEN" \
  offering_uuid=="a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  q=="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.offering_keycloak_groups import offering_keycloak_groups_search_remote_users_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = offering_keycloak_groups_search_remote_users_list.sync(
    client=client,
    offering_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    q="string-value"
)

for item in response:
    print(item)
  1. API Source: offering_keycloak_groups_search_remote_users_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { offeringKeycloakGroupsSearchRemoteUsersList } from 'waldur-js-client';

try {
  const response = await offeringKeycloakGroupsSearchRemoteUsersList({
  auth: "Token YOUR_API_TOKEN",
  query: {
    "offering_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "q": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
offering_uuid string ✓ UUID of the offering
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
q string ✓ Search query for username, email, or name
resource_uuid string (uuid)
role_uuid string (uuid)

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
id string
username string
email string
first_name string
last_name string

Compare local and remote Keycloak group state

1
2
3
4
5
http \
  GET \
  https://api.example.com/api/offering-keycloak-groups/sync_status/ \
  Authorization:"Token YOUR_API_TOKEN" \
  offering_uuid=="a1b2c3d4-e5f6-7890-abcd-ef1234567890"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.offering_keycloak_groups import offering_keycloak_groups_sync_status_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = offering_keycloak_groups_sync_status_retrieve.sync(
    client=client,
    offering_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
)

print(response)
  1. API Source: offering_keycloak_groups_sync_status_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { offeringKeycloakGroupsSyncStatusRetrieve } from 'waldur-js-client';

try {
  const response = await offeringKeycloakGroupsSyncStatusRetrieve({
  auth: "Token YOUR_API_TOKEN",
  query: {
    "offering_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
offering_uuid string ✓ UUID of the offering

200 -

Field Type
local_only array of strings
remote_only array of strings
synced array of objects
synced.local_name string
synced.remote_name string
synced.backend_id string

Import a remote Keycloak group as a local OfferingKeycloakGroup

1
2
3
4
5
6
7
http \
  POST \
  https://api.example.com/api/offering-keycloak-groups/import_remote/ \
  Authorization:"Token YOUR_API_TOKEN" \
  offering_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  role_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  remote_group_id="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.import_remote_group_request import ImportRemoteGroupRequest # (1)
from waldur_api_client.api.offering_keycloak_groups import offering_keycloak_groups_import_remote # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ImportRemoteGroupRequest(
    offering_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    role_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    remote_group_id="string-value"
)
response = offering_keycloak_groups_import_remote.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ImportRemoteGroupRequest
  2. API Source: offering_keycloak_groups_import_remote
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
import { offeringKeycloakGroupsImportRemote } from 'waldur-js-client';

try {
  const response = await offeringKeycloakGroupsImportRemote({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "offering_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "role_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "remote_group_id": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required
offering_uuid string (uuid) ✓
role_uuid string (uuid) ✓
remote_group_id string ✓
resource_uuid string (uuid)
scope_id string

201 -

Field Type Description
uuid string (uuid)
url string (uri)
name string
backend_id string
offering string (uri)
offering_uuid string (uuid)
offering_name string
role string (uri)
role_name string
role_scope_type string Level this role applies at, e.g. 'cluster', 'project'. Empty means offering-wide.
resource string (uri)
resource_uuid string (uuid)
resource_name string
scope_id string Sub-entity identifier within a resource, e.g. Rancher project ID within a cluster.
created string (date-time)
modified string (date-time) 
1
2
3
4
http \
  POST \
  https://api.example.com/api/offering-keycloak-groups/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_backend_id/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.set_backend_id_request import SetBackendIdRequest # (1)
from waldur_api_client.api.offering_keycloak_groups import offering_keycloak_groups_set_backend_id # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = SetBackendIdRequest()
response = offering_keycloak_groups_set_backend_id.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: SetBackendIdRequest
  2. API Source: offering_keycloak_groups_set_backend_id
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { offeringKeycloakGroupsSetBackendId } from 'waldur-js-client';

try {
  const response = await offeringKeycloakGroupsSetBackendId({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
backend_id string
resource_uuid string (uuid)
scope_id string

200 -

Field Type Description
uuid string (uuid)
url string (uri)
name string
backend_id string
offering string (uri)
offering_uuid string (uuid)
offering_name string
role string (uri)
role_name string
role_scope_type string Level this role applies at, e.g. 'cluster', 'project'. Empty means offering-wide.
resource string (uri)
resource_uuid string (uuid)
resource_name string
scope_id string Sub-entity identifier within a resource, e.g. Rancher project ID within a cluster.
created string (date-time)
modified string (date-time)

Test Keycloak connection for an offering

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/offering-keycloak-groups/test_connection/ \
  Authorization:"Token YOUR_API_TOKEN" \
  offering_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.offering_uuid_request import OfferingUUIDRequest # (1)
from waldur_api_client.api.offering_keycloak_groups import offering_keycloak_groups_test_connection # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OfferingUUIDRequest(
    offering_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
)
response = offering_keycloak_groups_test_connection.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OfferingUUIDRequest
  2. API Source: offering_keycloak_groups_test_connection
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { offeringKeycloakGroupsTestConnection } from 'waldur-js-client';

try {
  const response = await offeringKeycloakGroupsTestConnection({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "offering_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required
offering_uuid string (uuid) ✓

200 -

Field Type
status string
groups_count integer
groups array of strings

Offering keycloak memberships

Offering Keycloak Memberships

Operations Summary

Method Endpoint Description
GET /api/offering-keycloak-memberships/ List Offering Keycloak Memberships
GET /api/offering-keycloak-memberships/{uuid}/ Retrieve
POST /api/offering-keycloak-memberships/ Create
DELETE /api/offering-keycloak-memberships/{uuid}/ Delete

List Offering Keycloak Memberships

1
2
3
4
http \
  GET \
  https://api.example.com/api/offering-keycloak-memberships/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.keycloak_user_group_membership_state import KeycloakUserGroupMembershipState # (1)
from waldur_api_client.api.offering_keycloak_memberships import offering_keycloak_memberships_list # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = offering_keycloak_memberships_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: KeycloakUserGroupMembershipState
  2. API Source: offering_keycloak_memberships_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { offeringKeycloakMembershipsList } from 'waldur-js-client';

try {
  const response = await offeringKeycloakMembershipsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
email string
first_name string
group_uuid string (uuid)
last_name string
offering_uuid string (uuid)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
resource_uuid string (uuid)
role_uuid string (uuid)
state array
username string

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid)
url string (uri)
username string Keycloak user username
email string (email) User's email for notifications
first_name string
last_name string
group string (uri)
group_name string
group_role_name string
group_offering_uuid string (uuid)
group_offering_name string
group_resource_name string
group_resource_uuid string (uuid)
group_scope_id string Sub-entity identifier within a resource, e.g. Rancher project ID within a cluster.
group_role_scope_type string Level this role applies at, e.g. 'cluster', 'project'. Empty means offering-wide.
group_role_scope_type_label string Human-readable label for scope_type shown to end users, e.g. 'Rancher Project', 'Cluster Namespace'. Falls back to capitalized scope_type if empty.
user string (uri)
state any
created string (date-time)
modified string (date-time)
last_checked string (date-time)
error_message string
error_traceback string

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/offering-keycloak-memberships/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.offering_keycloak_memberships import offering_keycloak_memberships_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = offering_keycloak_memberships_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: offering_keycloak_memberships_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { offeringKeycloakMembershipsRetrieve } from 'waldur-js-client';

try {
  const response = await offeringKeycloakMembershipsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
uuid string (uuid)
url string (uri)
username string Keycloak user username
email string (email) User's email for notifications
first_name string
last_name string
group string (uri)
group_name string
group_role_name string
group_offering_uuid string (uuid)
group_offering_name string
group_resource_name string
group_resource_uuid string (uuid)
group_scope_id string Sub-entity identifier within a resource, e.g. Rancher project ID within a cluster.
group_role_scope_type string Level this role applies at, e.g. 'cluster', 'project'. Empty means offering-wide.
group_role_scope_type_label string Human-readable label for scope_type shown to end users, e.g. 'Rancher Project', 'Cluster Namespace'. Falls back to capitalized scope_type if empty.
user string (uri)
state any
created string (date-time)
modified string (date-time)
last_checked string (date-time)
error_message string
error_traceback string

Create

1
2
3
4
5
6
7
8
http \
  POST \
  https://api.example.com/api/offering-keycloak-memberships/ \
  Authorization:"Token YOUR_API_TOKEN" \
  username="alice" \
  email="alice@example.com" \
  offering="https://api.example.com/api/offering/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
  role="https://api.example.com/api/role/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.offering_keycloak_membership_request import OfferingKeycloakMembershipRequest # (1)
from waldur_api_client.api.offering_keycloak_memberships import offering_keycloak_memberships_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OfferingKeycloakMembershipRequest(
    username="alice",
    email="alice@example.com",
    offering="https://api.example.com/api/offering/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    role="https://api.example.com/api/role/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = offering_keycloak_memberships_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OfferingKeycloakMembershipRequest
  2. API Source: offering_keycloak_memberships_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { offeringKeycloakMembershipsCreate } from 'waldur-js-client';

try {
  const response = await offeringKeycloakMembershipsCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "username": "alice",
    "email": "alice@example.com",
    "offering": "https://api.example.com/api/offering/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
    "role": "https://api.example.com/api/role/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
username string ✓ Keycloak user username
email string (email) ✓ User's email for notifications
offering string (uri) ✓
Constraints: write-only
role string (uri) ✓
Constraints: write-only
resource string (uri)
Constraints: write-only
scope_id string
Constraints: write-only, default: ``
user string (uri)

201 -

Field Type Description
uuid string (uuid)
url string (uri)
username string Keycloak user username
email string (email) User's email for notifications
first_name string
last_name string
group string (uri)
group_name string
group_role_name string
group_offering_uuid string (uuid)
group_offering_name string
group_resource_name string
group_resource_uuid string (uuid)
group_scope_id string Sub-entity identifier within a resource, e.g. Rancher project ID within a cluster.
group_role_scope_type string Level this role applies at, e.g. 'cluster', 'project'. Empty means offering-wide.
group_role_scope_type_label string Human-readable label for scope_type shown to end users, e.g. 'Rancher Project', 'Cluster Namespace'. Falls back to capitalized scope_type if empty.
user string (uri)
state any
created string (date-time)
modified string (date-time)
last_checked string (date-time)
error_message string
error_traceback string

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/offering-keycloak-memberships/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.offering_keycloak_memberships import offering_keycloak_memberships_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = offering_keycloak_memberships_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: offering_keycloak_memberships_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { offeringKeycloakMembershipsDestroy } from 'waldur-js-client';

try {
  const response = await offeringKeycloakMembershipsDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

System logs

System Logs

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/system-logs/ List System Logs
GET /api/system-logs/{id}/ Retrieve
Other Actions
GET /api/system-logs/instances/ List system log instances
GET /api/system-logs/stats/ Get system log statistics

Core CRUD

List System Logs

1
2
3
4
http \
  GET \
  https://api.example.com/api/system-logs/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.system_log_level_enum import SystemLogLevelEnum # (1)
from waldur_api_client.models.system_log_o_enum import SystemLogOEnum # (2)
from waldur_api_client.models.system_log_source_enum import SystemLogSourceEnum # (3)
from waldur_api_client.api.system_logs import system_logs_list # (4)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = system_logs_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: SystemLogLevelEnum
  2. Model Source: SystemLogOEnum
  3. Model Source: SystemLogSourceEnum
  4. API Source: system_logs_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { systemLogsList } from 'waldur-js-client';

try {
  const response = await systemLogsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
created_from number
created_to number
instance string
level string Enum: CRITICAL, ERROR, INFO, WARNING
level_gte integer Min level: 20=INFO, 30=WARNING, 40=ERROR, 50=CRITICAL
logger_name string
message string
o array Ordering
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
source string Enum: api, worker, beat

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
id integer
created string (date-time)
source any
instance string Pod name (K8s) or container name (Docker)
level string
level_number integer
logger_name string
message string
context any

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/system-logs/123/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.system_logs import system_logs_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = system_logs_retrieve.sync(
    id=123,
    client=client
)

print(response)
  1. API Source: system_logs_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { systemLogsRetrieve } from 'waldur-js-client';

try {
  const response = await systemLogsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "id": 123
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required Description
id integer ✓ A unique integer value identifying this system log.

200 -

Field Type Description
id integer
created string (date-time)
source any
instance string Pod name (K8s) or container name (Docker)
level string
level_number integer
logger_name string
message string
context any

Other Actions

List system log instances

List all known instances (pods/containers) with their last activity.

1
2
3
4
http \
  GET \
  https://api.example.com/api/system-logs/instances/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.system_log_level_enum import SystemLogLevelEnum # (1)
from waldur_api_client.models.system_log_o_enum import SystemLogOEnum # (2)
from waldur_api_client.models.system_log_source_enum import SystemLogSourceEnum # (3)
from waldur_api_client.api.system_logs import system_logs_instances_list # (4)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = system_logs_instances_list.sync(client=client)

for item in response:
    print(item)
  1. Model Source: SystemLogLevelEnum
  2. Model Source: SystemLogOEnum
  3. Model Source: SystemLogSourceEnum
  4. API Source: system_logs_instances_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { systemLogsInstancesList } from 'waldur-js-client';

try {
  const response = await systemLogsInstancesList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
created_from number
created_to number
instance string
level string Enum: CRITICAL, ERROR, INFO, WARNING
level_gte integer Min level: 20=INFO, 30=WARNING, 40=ERROR, 50=CRITICAL
logger_name string
message string
o array Ordering
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
source string Enum: api, worker, beat

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
source string
instance string
last_seen string (date-time)
count integer

Get system log statistics

Return log count statistics per source and instance, plus total table size.

1
2
3
4
http \
  GET \
  https://api.example.com/api/system-logs/stats/ \
  Authorization:"Token YOUR_API_TOKEN"

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.system_logs import system_logs_stats_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = system_logs_stats_retrieve.sync(client=client)

print(response)
  1. API Source: system_logs_stats_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { systemLogsStatsRetrieve } from 'waldur-js-client';

try {
  const response = await systemLogsStatsRetrieve({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

200 -

Field Type
instances array of objects
instances.source string
instances.instance string
instances.count integer
total_size_bytes integer
total_size_mb number (double)